https://github.com/tglide/ur-api-revamped

https://github.com/tglide/ur-api-revamped

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/tglide/ur-api-revamped
• Owner: TGlide
• Created: 2020-04-28T00:25:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T03:40:27.000Z (about 2 years ago)
• Last Synced: 2024-10-14T08:45:32.673Z (3 months ago)
• Language: Python
• Size: 728 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Uniao Rio Projections API

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)

## Description

This is an API for storing COVID-19 projections in the state of Rio de Janeiro, Brazil, made by the União Rio Team

Based on https://github.com/cosmic-byte/flask-restplus-boilerplate.

## Installation

- Clone/Download this repo

- Make sure you have the latest version of `Python 3` and `PostgreSQL` installed.

- (Optional) Create a virtual environment on the root of the project

- Install the requirements with `pip install -r requirements .txt`

- Create a new database on `PostgreSQL`

- Copy the contents of `.env.example` onto a new `.env` file, replacing the contents between `{}` with the needed information

- Run the following commands to initialize the DB:

  - `python manage.py db init`

  - `python manage.py db migrate`

  - `python manage.py db upgrade`

- Run `python manage.py db run`

That's it!

## Contributing

Contributors are welcome! As this is a commitizen friendly repo, please follow this instructions when committing:

- Make sure you have `yarn` installed

- Run `yarn`

- Run `yarn global add commitizen`

- For every commit, run `git cz` instead of `git commit`

## License

This project is under the GNU General Public License v3.0