Para ler esse arquivo em português, vá ao README-ptbr.md

This is a project for compile data from Dados Abertos da Camara and serve though API to Camara data portal.

These instructions will get you a copy of the project up and running on your local machine with docker for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

First, have docker, please. Then follow installation steps. If you want to run locally, iit is possible But I have no instructions here. Sorry.

1. Install docker To install docker, please refer to their website and follow the instructions for your operational system.

2. Copy the example environment file

$ cp .env.example .env

We plan to have the tutorial to install locally, but we do not yet.

To run the api with docker, just run the following command

$ docker-compose up

For some people who built the project previously (docker-compose.dev.yml) you may face some problems, try the following commands:

$ docker-compose down && docker-compose build --no-cache

⚠️ If the problem persists please add an issue to get help, you can also try to remove the api and the task images manually and re-run docker-compose up

Here are some tips...

When changing a model, you will need to create new migrations and migrate them so they be applied on the database schema.

To create migrations based on the the changes in the model, run the following command

$ docker-compose exec api python ./manage.py makemigrations

To migrate and apply them to the database, run the following command

$ docker-compose -f docker-compose.dev.yml exec api python ./manage.py migrate

To test the email, we have included the mailhog. It makes it possible to test sending and receiving emails by accessing: localhost:8025. By default django is already configured to use it.

Add additional notes about how to deploy this on a live system

• Django - DjangoThe web framework for perfectionists with deadlines.

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Please read Code of Conduct. And always be considerate and respectful.

We will use SemVer for versioning.

This project is licensed under the MIT License - see the LICENSE.md file for details

Go to the contributors page to see who participated in this project.