Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/abhishekjadhav2002/proelevate-backend-assignment

eslint express husky jsonwebtoken mongoose postman prettier typescript

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/abhishekjadhav2002/proelevate-backend-assignment
Owner: AbhishekJadhav2002
Created: 2024-02-24T14:50:02.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-02-25T14:32:19.000Z (9 months ago)
Last Synced: 2024-02-26T13:44:35.833Z (9 months ago)
Topics: eslint, express, husky, jsonwebtoken, mongoose, postman, prettier, typescript
Language: TypeScript
Homepage: https://proelevate-backend-virb.onrender.com/health
Size: 73.2 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

# Proelevate Backend Assignment

##### Installation

```bash
npm ci
```

Fill in the environment variables in the `.env` file, refer to the `.env.example` file for the required variables.

```bash
cp .env.example .env
```

##### Usage `(in development mode)`

After Redis and MongoDB is running for development environment, start the Express Server

```bash
npm run dev
```

> Make sure all the ticks are green in the terminal.

---

##### Development Guidelines

- ###### Code Formatting

- Add files to the staging area
- Use `npm run format` to run the eslint and prettier checks on the staged files manually

---

##### API Documentation

[![Run in Postman](https://run.pstmn.io/button.svg)](https://documenter.getpostman.com/view/20772277/2sA2rCVN8z)