https://github.com/supansatan/board-api

https://github.com/supansatan/board-api

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/supansatan/board-api
• Owner: SupansaTan
• Created: 2024-07-15T08:03:29.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-16T00:30:15.000Z (about 2 years ago)
• Last Synced: 2025-10-24T23:40:38.014Z (9 months ago)
• Language: TypeScript
• Homepage: https://board-api.vercel.app
• Size: 209 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Board API

## Installation

```bash

$ npm install

```

## Setting environment file

Adding .env file with the below variable

```bash

JWT_SECRET=SECRETsecretSECRET

```

## Running the app

serve will run on `localhost:4000`

```bash

# development

$ npm run start

# watch mode

$ npm run start:dev

# production mode

$ npm run start:prod

```

## Swagger path

```bash

localhost:4000/api

```

## Unit tests

```bash

# unit tests

$ npm run test

# unit tests with test coverage

$ npm run test:cov

```