README.md

Adottami Backend

• Technologies
• Installation
• Development guide
  • Tests
    • Unit and integration tests

Technologies

• Node.js, Express and Typescript
• Prisma and PostgreSQL
• Linting with ESLint
• Formatting with Prettier
• Pre-commit and pre-push Git hooks with Husky
• Testing with Jest

Installation

This project runs on Node.js v16 and uses Yarn v1 as dependency manager.

1. Clone the repository and install dependencies:

   $ git clone [email protected]:es-2021-2-grupo-2/adottami-backend.git
   $ cd adottami-backend
   $ yarn install

2. To run the project in development mode, start a development database:

   $ yarn db:up

3. Apply the current schema (if the database is not up-to-date):

   $ yarn db:migrate

4. Start the server in development mode:

   $ yarn dev

Development guide

Learn more about the contributing conventions and guidelines at CONTRIBUTING.md.

Tests

The project uses Jest for unit and integration tests.

Unit and integration tests

Once you have installed the project dependencies as explained at Installation, run the following command to run the project's unit and integration tests:

$ yarn test

To learn more about the CLI options supported by Jest, access the documentation.