murugaratham/teacher-student

Teacher student registration API

1. Create a database CREATE DATABASE <dbname>;
2. update .env file (we should .gitignore this and upload a .env.example but...)
3. Optionally, seed the database with a little data
4. npm install
5. npm run start or npm run watch for dev mode
6. npm run test or npm run test:dev for unit test dev mode

these are my npm global packages, if you need

garylee@iMac [~] ]$ npm list -g --depth=0
/usr/local/lib
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
└── [email protected]

Sample .env config

PORT=80
SQLUSER=root
SQLPASSWORD=P@ssw0rd!
SQLHOST=localhost
SQLDATABASENAME=<dbname>

how to run seeders (optional)

node_modules/.bin/sequelize db:seed:all

TODO

• modularize routes
• catch all routes
• nodemon
• prettier rc
• eslint
• env file for ports
• jest test setup
• user story 1 POST /api/register
• user story 2 GET /api/commonstudents
• user story 3 POST /api/suspend
• user story 4 POST /api/retrievefornotifications

-- create database mba; -- if you use new auth protocol, you might get 'please upgrade client warning', do this till mysql2 driver supports the new protocol

ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'P@ssw0rd!'