CRED-T5

Team ID: CRED-T5 | Team Members: Chinmay Chougaonkar & Ayush Gupta

Key Points:

• The project fulfills both P0 and P1 requirements completely
• Both back-end and front-end are publicly deployed in an AWS EC2 instance
• Back-end URL
• Front-end URL
• Swagger is available at /swagger-ui endpoint

Tech-Stack used:

• Back-end: NodeJS, ExpressJS
• Front-end: ReactJS
• Database: PostgreSQL
• Testing library: Jest

Database Schema:

• View DB Schema used for the project in this diagram

Setting up and running the back-end server (For UNIX/Linux only):

• Clone the repository
• Change current directory to backend/ by running: cd CRED-T5/backend/
• Copy .env-template into a new file .env in the same directory by running: cp .env-template .env
• Edit .env file adding values for all the fields based on your system
• Edit scripts/setup.sh script by populating the db_name and pass variables as per your preferences.
• Now run: sh scripts/setup.sh && npm install && npm start to setup and run the back-end server.

Running the React App:

• Run: cd CRED-T5/frontend/
• Run: npm install && npm start