Skip to content

Latest commit

 

History

History
134 lines (102 loc) · 5.46 KB

README.md

File metadata and controls

134 lines (102 loc) · 5.46 KB
Raw

Palette 2021 Backend

Banner                     Dependencies GitHub Issues Contributions welcome License All Contributors

About

Palette 2021 Backend, This project was to create a backend that ensures a smooth functioning for participants of Palette 21.

Participants can register and log in either via their Google or Figma accounts. You can create a team or join an existing one. After registering, you can send invites to other participants who are looking for a teammate. The participant who received the invite can either accept or reject an invite.

Once the registration deadline passes, new users cannot register. Once the team formation deadline passes, you cannot change your team.

Each team can generate up to 3 new random problem statements. You and your teammate can either lock individual parts of the problem statement or the entire one at once. Once the three tries are over, your last generated problem statement is locked if you haven't locked one before it.

Each team has to submit their submission for the first round before the deadline passes. You can edit your submission as many times as you want. Once the deadline passes and the judges have released the qualified teams, the next round begins and only the qualified teams can make updates to their previous submissions accordingly for the next round.

About the Backend

  • Standard response structure was followed for a smoother integration
  • Google and Figma Oauth were used for the authentication along with Passport JWT
  • MVC architecture was implemented
  • Robust error handling to send specific errors to the frontend for a better UX experience
  • MongoDB deployed on Atlas was used as our database
  • Staging branch was deployed on Heroku to test the features before they were deployed to production
  • The master branch had the production code and was deployed on Microsoft Azure

Tech Stack

  • Node
  • Typescript
  • Express
  • MongoDB
  • Azure
  • Heroku

Getting Started

To get started:

  • Clone the repo. https://github.com/IEEE-VIT/palette-21-backend
  • Checkout to a new branch. git checkout -b my-amazing-feature
  • Make some amazing changes.
  • git add .
  • git commit -m "<verb> : <action>."
  • git push origin my-amazing-feature
  • Open a pull request :)

To start contributing, check out CONTRIBUTING.md . New contributors are always welcome to support this project.

Environment Variables

In order to run this project successfully, create a .env file filled with keys are shown below. Make sure to fill your credentials and values

DB_URI=<MongoDB URI>
client_id=<Google Oauth Client Id>
client_secret=<Google Oauth Client secret>
figma_client_id=<Figma Oauth Client Id>
figma_client_secret=<Figma Oauth Client Secret>
redirect_uri=<URL for OAuth Redirect>
FRONTEND_URL=<Frontend URL of Palette 21>
JWT_SECRET=<JWT secret key>
pb_stmt_deadline=2021-05-27 23:00
team_reg_deadline=2021-05-27 22:30
user_reg_deadline=2021-05-27 19:00
round_1_deadline=2021-05-28 12:40
round_2_deadline=2021-05-28 13:00
round_3_deadline=2021-05-29 21:00
round_2_result=2021-05-28 18:00
RECAPTCHA_KEY=<Google Recaptcha Key>
AWS_ID=<AWS Access key>
AWS_SECRET=<User secret key>
AWS_BUCKET_NAME=<AWS Buckey name>

You can refer the following references to fill in some of the keys mentioned above:

Development Run

yarn install
yarn dev

Production Run

yarn install
yarn start

Postman API Documentation

View here

Contributors ✨

Rush
Aarush Bhat
Hemanth Krishna
Ishan Khandelwal 		Noob
Shubham Palriwala

License

This project is licensed under MIT.

Made with ❤ by IEEE-VIT