Skip to content

Latest commit

 

History

History
161 lines (134 loc) · 5.08 KB

CONTRIBUTING.md

File metadata and controls

161 lines (134 loc) · 5.08 KB

Contributing Guidelines

👨‍💻 Getting started

This section will walk you through how you can get started with the project.

Directory Layout

├── client
|      └── src
|           ├── assets
|           ├── components
|           |      ├── chatComp
|           |      ├── commentComp
|           |      ├── contractComp
|           |      ├── generalComp
|           |      ├── homeComp
|           |      ├── postComp
|           |      └── profileComp
|           |
|           ├── pages
|           |      ├── Chat.tsx
|           |      ├── Contracts.tsx
|           |      ├── Home.tsx
|           |      ├── Login.tsx
|           |      ├── Profile.tsx
|           |      └── Register.tsx
|           |
|           ├── types
|           |      ├── chatTypes.ts
|           |      ├── commentTypes.ts
|           |      ├── contractTypes.ts
|           |      ├── messageTypes.ts
|           |      ├── postTypes.ts
|           |      ├── searchTypes.ts
|           |      └── userTypes.ts
|           |
|           └── utils
|                  ├── apiRoutes.ts
|                  ├── globalConstants.ts
|                  ├── globalStyles.ts
|                  ├── helperFunction.ts
|                  ├── outsideAlerter.ts
|                  └── themes.ts
|
├── controllers
|      ├── authController.js
|      ├── chatController.js
|      ├── commentController.js
|      ├── contractController.js
|      ├── errorController.js
|      ├── handlerController.js
|      ├── messageController.js
|      ├── postController.js
|      └── userController.js 
|
├── models
|      ├── chatModel.js
|      ├── commentModel.js
|      ├── contractModel.js
|      ├── messageModel.js
|      ├── postModel.js
|      └── userModel.js 
|      
├── routes
|      ├── chatRoutes.js
|      ├── commentRoutes.js
|      ├── contractRoutes.js 
|      ├── messageRoutes.js 
|      ├── postRoutes.js 
|      └── userRoutes.js 
|   
├── utils
|      ├── apiFeatures.js
|      ├── appError.js
|      ├── catchAsync.js 
|      ├── email.js 
|      └── exludedFields.js 
|
├── views
|      ├── _style.pug
|      ├── baseEmail.pug
|      ├── passwordReset.pug 
|      └── welcome.pug 
|
├── app.js
|  
├── CONTRIBUTING.md
|
└── README.md

Run on your local server

You will need NodeJS, Git and MongoDB installed to run this project locally

  node@v16.13.0 or higher
  npm@8.1.0 or higher
  git@2.34.1 or higher

If you dont have MongoDB you use MongoDB Atls

  1. Clone the repo or fork this repo
git clone https://github.com/Garvit1809/WorkedIn

  1. Create a file called .env in the Backend directory of your project:

      - client
  - controllers
  - models
  - routes
  - utils
  - views
  - .env         <-- create it here
  - .gitignore
  - app.js
  - CONTRIBUTING.md
  - package-lock.json
  - package.json
  - README.ms

  2. Inside the .env file, add key MONGO_URL and assign your MongoDB local host or Mongo Atls like this. Also add PORT key and make sure to give it a value other than 3000 (client is running on 3000)

# .env
PORT = 5000 
MONGO_URL = "YOUR_DB_LOCAL_HOST" 
# eg : mongodb://localhost/stresser or mongodb+srv://"Your username ":" your password "....
  1. Starting the Server application
cd server 
npm install
nodemon index.js

This will start server on localhost:5000

  1. Starting the Client application.
cd client 
npm install
npm start

This will start client app on localhost:3000