realityzero / credilinq_backend

Notes from Author

• SME Healthcheck backend apis are deployed using Render
• Render is susceptible to cold start issue, it is recommended to open api spec/swagger first. Usually takes 1-2 mins.
• Backend swagger link
• Frontend is depoyed at Vercel, Click Me
• Refer .env.example file for example env variables
• Project uses Prisma as an ORM
• Postgres database is connected w/ Vercel Postgres, it suffers from occasional cold starts of 1-2 seconds.
• UEN is a 9-10 digit number given by Singapore Government e.g. "234323213X". Refer: What is Unique Entity Number (UEN) in Singapore
• APIs are tested for happy path. There will be some bugs available.

Instructions to follow for running

• Open swagger
• POST smehealthchecks request is for storing records i.e. used by frontend client and unprotected
• Remaining endpoints are protected
• Use endpoint POST /auth/login with credentials email: [e-mail] and password: supersecretpassword. Mainly for demonstration purposes.
• After login, you'll receive JWT Authorisation token. Copy and paste this token in Authorize option at the top of Swagger.
• Now you can try out other protected apis.

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

License

Nest is MIT licensed.