web-dev-project-server

Endpoint link

Website Link

This repo contains the source-code for the backend of the chowk app.

Refer to this link for the front-end code.

Here is a demo of the site.

Pre-requisites

• npm
• mysql db

Setup

• Install everything

  $ npm install

• Lookup the package.json file for all the dependencies.
• Add a .dev.env(when running in dev environment. .env will be required when running a production build) file at the project root.
• It will have the following entries, depending on what is to be connected -

  DB_TYPE=mysql
  DB_HOST=localhost
  DB_PORT=3306
  DB_USERNAME=<YOUR_DB_USERNAME>
  DB_PASSWORD=<YOUR_DB_PASSWORD>
  DB_SCHEMA=<YOUR_DB_NAME>
  

Running dev environment

• Run -

  $ npm run dev

• This should start a local server.
• Every change will be instantly reflected, without a restart.

Prod build

• Run -

  $ npm run start-prod

• This should create a build directory, with the transpiled js files.

Deployment

• Auto deployed on merging PRs into develop branch.

API References -

All the APIs are described here

Resources, Heavily used frameworks -

• Writing Typescript with express -
  • https://typeorm.io/#/example-with-express
  • https://levelup.gitconnected.com/setup-express-with-typescript-in-3-easy-steps-484772062e01
• TypeORM
• Overnight-js
• Passport-js

Project Team members

• Keshav Chandrashekar- keshavchen
• Nithin Gangadharan - gnithin
• Tanmay Naik - tsnaik
• Viral Patel - patelviralb