https://github.com/larissaperinoto/schedules-api

Therapist appointment scheduling service.
https://github.com/larissaperinoto/schedules-api

docker jest nest nestjs nodejs postgresql typeorm typescript

Last synced: 4 days ago
JSON representation

Therapist appointment scheduling service.

• Host: GitHub
• URL: https://github.com/larissaperinoto/schedules-api
• Owner: larissaperinoto
• Created: 2024-06-13T11:08:05.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-14T09:42:34.000Z (7 months ago)
• Last Synced: 2024-11-13T03:14:53.328Z (2 months ago)
• Topics: docker, jest, nest, nestjs, nodejs, postgresql, typeorm, typescript
• Language: TypeScript
• Homepage:
• Size: 233 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Schedules Service

### Tecnologies and Tools

- [Node.Js](https://nodejs.org/en)

- [Nest.Js](https://nestjs.com/)

- [Jest](https://jestjs.io/)

- [PostgreSQL](https://www.postgresql.org/)

### Pre requirements to run the project

- Node.Js (version >= 16)

- Docker or local Postgres

- Yarn

### Running the project

Clone this repository

        git clone [email protected]:larissaperinoto/schedules-api.git

Install dependencies

        yarn install

#### Running with Docker

Create a postgres container with the command below

        docker run --name my-postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres

Check if the container was created. You should see **my-postgres** on the list

        docker ps

Create tables with the command bellow

        docker exec -i my-postgres psql -U postgres < database.sql

#### Running with local Postgres

Through the terminal, log into your postgres and run the command bellow to create postgres database

        CREATE DATABASE postgres;

Then copy the contents of the **database.sql** file located at the root of the project and run the query to create the tables

#### Environment

Create a .env file in the root and define your project's environment variables

        PORT=3001

        DB_NAME=postgres

        DB_PORT=5432

        DB_HOST=localhost

        DB_USERNAME=postgres

        DB_PASSWORD=postgres

Start the application

        yarn start

If you want to start as a developer, use the command below

        yarn start:dev

#### Running tests

Run all tests at the same time

        yarn test

Run a specific test

        yarn test 

Run tests with coverage

        yarn test --coverage

        or

        yarn test  --coverage

### Documentation

After starting the service, check the endpoint documentation using the address below in the browser

        http://localhost:3001/api

You can test the endpoints through the documentation page using the **Try it out** button or through your preferred client