From 8c95593d5b237a255ae4fbdb84eb48904990ca42 Mon Sep 17 00:00:00 2001 From: sanchita-07 Date: Thu, 29 Sep 2022 16:08:45 +0530 Subject: [PATCH] readme file update --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1052c2f..82318a3 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,27 @@ -# Zairza Web Backend +# Skills++ Backend -The official backend of Zairza ! +The official backend of Skills++ Event ! + +## Table of Contents + +- [Manual Installation](#manual-installation) +- [Project Structure](#project-structure) +- [Error Handling](#error-handling) +- [Logging](#logging) ## Manual Installation Clone the repo : ```bash -git clone https://github.com/subrat0796/Zairza-web.git -cd Zairza-web +git clone https://github.com/zairza-cetb/skills-backend.git +cd skills-backend ``` Install the dependencies : ```bash -cd backend && npm install +npm install ``` Set the environment variables: @@ -25,12 +32,6 @@ cp .env.example .env #open .env and modify the variables according to your needs ``` -## Table of Contents - -- [Project Structure](#project-structure) -- [Error Handling](#error-handling) -- [Logging](#logging) - ## Project Structure ``` @@ -43,9 +44,9 @@ src\ |--models\ # Mongoose models (data layer) |--routes\ # Routes |--services\ # Business logic (service layer) + |--utils\ # Utility classes and functions |--validations\ # Request data validation schemas - |--config\ # Envoriment variables and configuration related things - |--app.js # Express app + |--config\ # Environment variables and configuration related things |--index.js # App entry point ``` @@ -115,4 +116,4 @@ In production mode, only `info`, `warn`, and `error` logs will be printed to the It is up to the server (or process manager) to actually read them from the console and store them in log files.\ This app uses pm2 in production mode, which is already configured to store the logs in log files. -Note: API request information (request url, response code, timestamp, etc.) are also automatically logged (using [morgan](https://github.com/expressjs/morgan)). +Note: API request information (request url, response code, timestamp, etc.) are also automatically logged (using [morgan](https://github.com/expressjs/morgan)). \ No newline at end of file