How to run in local?
- Clone the repo using:
- Run the command in root:
yarnORnpm install - Create .env file in the root and paste the your secrets as described in env.example in there.
- To run the backend:
yarn devORnpm run dev - To build:
yarn buildORnpm run build - To start the build:
yarn start:buildORnpm run start:build - To build the backend and start:
yarn build:startORnpm run build:start
.
├── node_modules/
├── @types/
│ └── types.d.ts - this file contains types used in whole app
└── configs/
│ ├── aws.ts - this file contains aws configurations
│ ├── db.ts - this file contains db connection logic
│ └── env.ts - this file contains all envs read from .env
└── context/
│ └── index.ts - this file contains users list connected to socket
│ and the functions to manipulate that list
└── controllers/ - this contains all the controllers
│ ├── auth.controller.ts
│ ├── aws-upload.controller.ts
│ ├── chat.controller.ts
│ └── user.controller.ts
└── middlewares/
│ └── auth.middleware.ts - middleware to check athorization of the user
└── models/ - mongoose models
│ ├── chat.model.ts
│ ├── message.model.ts
│ ├── user.model.ts
│ └── types.d.ts
└── routes/ - contains all routes
│ ├── auth.route.ts
│ ├── aws-upload.route.ts
│ ├── chat.route.ts
│ └── user.route.ts
└── utils/ - contains all utility functions
│ ├── jwt.ts
│ └── response.ts
└── index.ts - ROOT OF THE APP
Response structure:
{
data?: any;
error?: string;
message?: string;
token?: string;
statusCode?: number;
}
- Auth end points:
- POST: api/auth/sign-up
- Body structure:
{ "username": "Username", "email": "[email protected]", "password": "Password@123" }
- Body structure:
- POST: api/auth/sign-in
- Body structure:
{ "email": "[email protected]", "password": "Password@123" }
- Body structure:
- POST: api/auth/sign-out
- Body structure:
{ "email": "[email protected]", "password": "Password@123" }
- Body structure:
- POST: api/auth/sign-up
- AWS file upload end points:
- POST: api/file/upload
- multipart/form-data structure:
file: <pdf, png, jpeg, jpg, gif> & <= 3MB
- multipart/form-data structure:
- DELETE: api/file/delete
- Body structure:
{ "email": "[email protected]", "password": "Password@123" }
- Body structure:
- POST: api/file/upload
- Chat end points
- GET: /api/chats/
- GET: /api/chats/conversation/:userId
- POST: api/chats/message/:userId
- Body structure:
{ "message": "How are you?" }
- Body structure:
- PATCH: api/chats/message/:messageId
- Body structure:
{ "message": "How are you?" }
- Body structure:
- DELETE: api/chats/message/:messageId
- User end points
- GET: /api/users/
- query structure:
- ?key=<username_or_email_to_search_user>
- query structure:
- GET: /api/users/me
- PATCH: api/users/update/
- Body structure:
{ "email"?:"[email protected]" "username"?:"Username123" "password"?:"Password@123" "avatar"?:"link_to_avatar" }
- Body structure:
- GET: /api/users/