axios-cp-wing

README

AXIOS-CP-WING

Platform for listing and tracking solved CP problems for students and the Competitive Programming Club of IIIT Lucknow.

Features

• User login/signup with @iiitl.ac.in email for tracking personal solved problems.

• Listing of Coding Tasks under different lists (Getting Started/Internship Prep/ Pro CP) with problem Tags.

• Unit Testing for API handlers using Go-Mock

• Github Workflow for Testing Compilability and Running Unit Tests on Push

• Admin User with permissions to dynamically create/edit problem lists.

• Email Verification feature through OTP on Gmail. (TODO: Password reset feature)

• Problems filters based on different tags.

• Logging to keep track of Admin actions.

• Deployment using proper CI/CD

Databse Schema

API Documentation (To Be Updated)

HealthCheck APIs

1. GET /ping

Description

• Simple ping API to check if server is online.
• To be modified later to pull out system health logs etc.

Request

• Method: GET
• Path: /ping

Response

• Status Code: 200 (OK)
• Content Type: application/json

Example

Request Body

[]

cURL snippet

curl  -X GET \
  'localhost:8080/ping'

Response Body

{
    "message": "Pong"
}