Skip to content

README.md

Latest commit

 

History

History
20 lines (16 loc) · 967 Bytes

README.md

File metadata and controls

20 lines (16 loc) · 967 Bytes
Raw

CoderHack Leaderboard API

Description

This is a RESTful API service for managing a leaderboard for a coding contest platform using Spring Boot and MongoDB. It supports user registration, score updates, and badge assignments.

Endpoints

  • GET /users: Retrieve a list of all users sorted by score.
  • GET /users/{userId}: Retrieve a specific user.
  • POST /users: Register a new user.
  • PUT /users/{userId}: Update a user's score.
  • DELETE /users/{userId}: Deregister a user.

Setup

  1. Install MongoDB. or I have used Mongo Atlas (Cloud) Database and connected to Db using 'Connection String'.
  2. Clone this repository.
  3. Run ./gradlew bootrun to start the application.
  4. Use the provided Postman collection to interact with the API.

Postman Collection

Download the collection here