Appreciating people for the good things they do.

About   |    Installation   |    Getting Started   |    License   |   

📖 About

Development of a Node.js REST API to praise people through tags.

👷 Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone https://github.com/lemuelZara/appreciate.git

If you use a SSH key registered in your GitHub account, clone this repository following command:

git clone git@github.com:lemuelZara/appreciate.git

Install dependencies

yarn install

# or

npm install

After installation, create your enviroment variables to use in this project (based on the example of .env.example):

cp .env.example .env

Setup a database

The PostgreSQL database is being used in this project. If you have Docker installed on your machine, fill the environment values related to database configurations and then run the following commands in order to create a PostgreSQL container:

docker-compose up -d

🏃 Getting Started

Run the command in order to configure the database schema:

yarn prisma migrate dev

Run the following command in order to start the application:

yarn start:dev

Tests

This project are coverage by tests. If you make any changes to the code, run the commands to check if your code is passing:

yarn test

# or

yarn test:watch

# Coverage Report
yarn test:cov

📕 License

Released in 2021. This project is under the MIT License.

Made with love by Lemuel 💜🚀