Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readme file update #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

readme file update #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c95593
readme file update
sanchita-07 Sep 29, 2022
1215572
Merge branch 'zairza-cetb:main' into readme
sanchita-07 Dec 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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

```
Expand All @@ -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
```

Expand Down Expand Up @@ -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)).