README.md

PAGARME-BAD-CODE

Getting Started

These instructions will get you a copy of the project up and running on your local machine for production purposes.

Installing

A step by step that gets you a production environment running:

Clone the project:

git clone https://github.com/dougtq/pokemon_api.git

Rename .env.example:

mv .env.example .env

Running

Starting the project running in docker

docker-compose up -d

To validate if the service has gone up, just make an HTTP request by the GET method at http://0.0.0.0:3000/healthcheck

Running the tests

Use the test script to run the test:

yarn test:live

Coding style

• Standard

Built With

• Express - The framework used

• Sequelize - The ORM used

• SQLite - The database used

Author

• Douglas E. Alves

License

This project is licensed under the ISC License - see the LICENSE file for details