Skip to content

Latest commit

 

History

History
55 lines (45 loc) · 1.4 KB

BUILD_GUIDE.md

File metadata and controls

55 lines (45 loc) · 1.4 KB
Raw

Project Setup Guide for a Developer :

  1. Initialized the app in following manner :
npm install express
npm install --save-dev nodemon
touch server.js
touch .gitignore
npm i mongoose
npm i dotenv
npm i eslint
  1. Did setup of eslint with following options
npm init @eslint/config
✔ How would you like to use ESLint? · To check syntax, find problems, and enforce code style
✔ What type of modules does your project use? · commonjs
✔ Which framework does your project use? · none
✔ Does your project use TypeScript? · No 
✔ Where does your code run? · node
✔ How would you like to define a style for your project? · guide
✔ Which style guide do you want to follow? · airbnb
✔ What format do you want your config file to be in? · JavaScript

  1. Other setups :

npm i express-fileupload
npm i express-validator
npm i cloudinary
npm i bcryptjs 
npm i jsonwebtoken
npm i cors

Main Project Structure

  1. server.js - Entry point for the backend server
  2. /routes - Folder for all routes
  3. /models - Folder for all schemas
  4. /utils - Folder for extra utility functions
  5. /middleware - Folder for middlewares
  6. /config - Folder for any configuration setups
  7. /controllers - To manage some business logic out of routes.

👉🏻👉🏻 Here are the learnings learnt from while developing this project.