machathon5_api

A REST API for the Machathon 5.00 Tech Summit and its competitions.

This api will interact with various services as needed, such as:

• summit registration form - link
• competition leaderboard - link
• Submission requests coming for competition simulator - Simulator link

Note: The event has successfully ended, so the official data has been removed, the current data is just dummy data for presentation.

Functionality

Event Registration

Event attendees will be able to register for the event through a web form.

Competition Registration (TBD)

Teams will be able to register for any competition in the event through a web form.

Competition Submission

Competitors solutions get submitted by sending a request to the API to store the submission in the database.

Leaderboard

Competitors will be able to see their scores and ranking through the competitions leaderboard.

Local Setup

• make sure you have NodeJS and PostgreSQL (or a serverless postgres database on neon) installed

using nvm is recommended for installing node

• Clone repo

git clone https://github.com/Apolo151/machathon5_api.git
cd machathon5_api

• install node modules

npm install

• create a .env file and add needed environment variables

touch .env

# example .env file
DATABASE_URL='YOUR DATABASE CONNECTION STRING'
SERVER_PORT=3000 # the port on which the servers listens to connections

• run server in development mode

npm run start-dev

• run unit tests

npm run test:unit

Future Plan/Improvements

• Add Endpoints for teams competition registarion
• Implement Auth

check issues for a comprehensive list