https://github.com/mattblack85/aldebaran

covid-19 pandemic JSON API
https://github.com/mattblack85/aldebaran

covid-19 jsonapi python starlette

Last synced: about 1 month ago
JSON representation

covid-19 pandemic JSON API

• Host: GitHub
• URL: https://github.com/mattblack85/aldebaran
• Owner: MattBlack85
• Created: 2020-03-15T11:05:47.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T10:56:46.000Z (about 2 years ago)
• Last Synced: 2024-12-16T04:35:03.525Z (about 2 months ago)
• Topics: covid-19, jsonapi, python, starlette
• Language: Python
• Homepage: https://aldebarancovid.docs.apiary.io/
• Size: 110 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# aldebaran

covid-19 pandemic JSON API.

Do you have any idea? Want more things from the API? Join on slack => https://aldebaran-group.slack.com/join/shared_invite/zt-cyh7edf9-LsKe_Y1Sci_ppJFIZqJbYw

## hard dependencies

The only hard dependencies required are `pipenv` and `direnv`(https://direnv.net/)

NOTE: if you are willing to use pip or load ENV vars by hand you won't need any of those.

## Setup the project

run `make bootstrap` to create the virtual environment and install the dependencies

create a new file .envrc from .envrc.EXAMPLE and use the following values:

```

export DB_PORT=9432

export DB_NAME=covid_test

export DB_PASSWORD=password

export DB_USER=aldebaran

export DB_HOST=localhost

export DEBUG=true

export PGPASSWORD=password

```

## Run the API

make sure the DB is up, `make db-up`

run `make start-aldebaran-local` and starlette should start the service