https://github.com/abhishekjadhav2002/bitespeed_backend_task

https://github.com/abhishekjadhav2002/bitespeed_backend_task

express nodejs postgresql sequalize typescr

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/abhishekjadhav2002/bitespeed_backend_task
• Owner: AbhishekJadhav2002
• Created: 2024-06-27T19:14:03.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-06-27T19:39:05.000Z (6 months ago)
• Last Synced: 2024-06-28T00:33:48.745Z (6 months ago)
• Topics: express, nodejs, postgresql, sequalize, typescr
• Language: TypeScript
• Homepage: https://bitespeed-backend-task-gbkt.onrender.com
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Bitespeed Backend Task

##### 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 Postgres is running for development environment, start the Express Server

```bash

npm run dev

```

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

---

##### Usage `(in production mode)`

```bash

npm start

```

##### 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/2sA3dsntwd)