Skip to content

CODE_OF_CONDUCT.md

Latest commit

 

History

History
62 lines (52 loc) · 1.82 KB

CODE_OF_CONDUCT.md

File metadata and controls

62 lines (52 loc) · 1.82 KB

CODE OF CONDUCT

TODO Checklist

  • Install eslint and prettier extensions in vs code and use the default settings defined in .vscode

Folder Structure

  • Add all image, assets, json files and other public files to public folder.
  • db-dump stores the db backup on migration.
  • config directory contains all the env, express, mongoose, socket and swagger configs.
  • controller contains all the api controllers.
  • helpers contains all the helper functions.
  • migrations folder contains all the DB migration files.
  • models folder contains all database models.
  • routes folder contain the api routes.
  • services folder contain all 3rd party service like email, payment gateway etc.
  • utils folder contain all the constants and swagger details.
.
├── ...
│    ├── config
│    │   ├── index
│    │   ├── env
│    │   ├── express
│    │   ├── mongoose
│    │   ├── socket
│    │   ├── swagger
│    ├── controllers
├── scr  ├── index
│    │   ├── baseController
│    ├── helpers
│    ├── middlewares
│    ├── migrations
│    ├── models
│    ├── routes
│    │   ├── v1
│    ├── services
│    ├── utils
│    │   ├── constants
│    │   ├── swaggerConfigs
│    ├── index.js
│    ├── migrate.js
├── public
├── db-dump
└── ...

Contributing

Pull requests (PRs) are welcome.

  • Create a branch with your name from dev branch.
  • Do changes in that branch.
  • Push changes to your branch and create PR to staging branch.
  • Get PR reviewed for sanity check and merge it to staging.
  • Then finally merge all changes from staging to main to deploy in prod.

License

MIT