diff --git a/backend/README.md b/backend/README.md index fc1cf5f2088def132b914d44be0b1c05e81de553..ab00c348e416a367f7f543b5ec48eb4657ec8eb7 100644 --- a/backend/README.md +++ b/backend/README.md @@ -14,22 +14,23 @@ npm start ## File Structure ``` -src -+-- config -| +-- config.js (Secret key & expiration JWT. Add Role string here when adding new role.) -| +-- db.config.js (Database and Sequelize config) -| +-- env.js (Wrapper for env variables) -| -+-- controller -| +-- *Controller.js (Add your controllers here) -| -+-- model -| +-- *.model.js (Add models here and follow the name convention) -| -+-- router -| +-- router.js (Routing goes here) -| +-- verifyJwtToken.js (Middleware functions involving JWT token should go here) -| +-- verifySignUp.js (Middleware functions involving Sign Up) -+-- app.js -.env.example (Example of .env file. Please copy this to .env and set it to your env) +backend ++-- src +| +-- config +| | +-- config.js (Secret key & expiration JWT. Add Role string here when adding new role.) +| | +-- db.config.js (Database and Sequelize config) +| | +-- env.js (Wrapper for env variables) +| | +| +-- controller +| | +-- *Controller.js (Add your controllers here) +| | +| +-- model +| | +-- *.model.js (Add models here and follow the name convention) +| | +| +-- router +| | +-- router.js (Routing goes here) +| | +-- verifyJwtToken.js (Middleware functions involving JWT token should go here) +| | +-- verifySignUp.js (Middleware functions involving Sign Up) +| +-- app.js ++-- .env.example (Example of .env file. Please copy this to .env and set it to your env) ``` \ No newline at end of file