URL	Status
CI	Private
Staging	Private
Production	Private

Description

User Backend for fc5y project

DB Set up

This section is deprecated. Please check /docs/SETTING_UP.md and /docs/RUNNING.md for more updated version.

DB information: ./config/config.json

To run db migration:

npx sequelize-cli db:migrate # run migration
npx sequelize-cli db:migrate:undo # undo the last migration
npx sequelize-cli db:migrate:status # migration log

Email certification:

Details

How to run

Development:

npm install
npm run dev

Test:

npm run test

Notice

Developers can modify everything but please provide the scripts to run dev, start and test.

For example:

• Developers can change the place of test files, developers can add test config
• Developers can change the folder structure to store routes, controllers or anything else
• Developers can change the content of starting script like "ENV_ABC=xyz node abc/index.js" but please remains the script command.

REST example

• Open your browser in localhost:4000 and try the example REST endpoints:
  • localhost:4000/api/users (GET)
  • localhost:4000/api/users/1 (GET)
  • localhost:4000/api/users (POST)
    • Body format: { username: 'john' }
  • localhost:4000/api/users/1 (PUT)
    • Body format: { username: 'john' }
  • localhost:4000/api/users/1 (DELETE)