https://github.com/ahmadyousif89/taski5y-api

backend rest api built using nest-js framework for the Taskify app
https://github.com/ahmadyousif89/taski5y-api

expressjs nestjs oauth2 postgresql

Last synced: about 6 hours ago
JSON representation

backend rest api built using nest-js framework for the Taskify app

• Host: GitHub
• URL: https://github.com/ahmadyousif89/taski5y-api
• Owner: AhmadYousif89
• Created: 2022-11-16T21:14:19.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-29T22:54:55.000Z (almost 2 years ago)
• Last Synced: 2023-03-09T23:40:55.313Z (over 1 year ago)
• Topics: expressjs, nestjs, oauth2, postgresql
• Language: TypeScript
• Homepage: https://taski5y.vercel.app
• Size: 1.97 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Personal Task API

## Description

This API was developed using [NestJs](https://github.com/nestjs/nest) framework.

## Installation

```bash

$ npm install

```

## Running the app

```bash

# development

$ npm run start

# watch mode

$ npm run start:dev

```

- running migrations without docker if you have postgress installed on your machine

```bash

# DATABASE_URL connection string example

$ DATABASE_URL=postgresql://[username]:[password]@localhost:5432/[db name]?schema=public

# prisma migration

$ npm run prisma:migrate

```

- running migrations with docker:

- please consider mapping your postgres port in DATABASE_URL connection string in the .env file to [ 5434:5432 ] to match with the docker-compose.yml file

```bash

# DATABASE_URL connection string example

$ DATABASE_URL=postgresql://[username]:[password]@localhost:5434/[db-name]?schema=public

# docker compose

$ npm run docker:restart

# prisma migration

$ npm run prisma:migrate

```

## Test

- first create .env.test file and adjust the postgres port to match with the one in docker-compose.yml - [ 5435:5432 ]

```bash

# DATABASE_URL connection string example

$ DATABASE_URL=postgresql://[username]:[password]@localhost:5435/[db-name]?schema=public

# unit tests

$ npm run test

# e2e tests

$ npm run test:e2e

# test coverage

$ npm run test:cov

```