geoguideproject/backend

REST API for GeoGuide

GeoGuide

Quick Start

Requirements

• Python
• pipenv

Basics

Install the required packages

$ pipenv install --dev

Set Environment Variables

$ cp .env.example .env

Generate a new APP_KEY

$ pipenv run python generate_key.py

Create DB

First you have to open pipenv shell

$ pipenv shell

If you don't have postgres installed, you can use Docker with Docker Compose to start a database container executing

$ docker-compose up -d db

Then you execute

$ python manage.py db init
$ python manage.py db upgrade

Get a dataset

You can download a .zip with all current supported datasets.

Feel free to try another dataset.

Run the Application

$ python manage.py runserver

So access the application at the address http://localhost:5000/

Want to specify a different port?

$ python manage.py runserver -h 0.0.0.0 -p 8080

Now you are ready to run the frontend project

Testing

Without coverage:

$ python manage.py test

With coverage:

$ python manage.py cov

backend's Issues

Update README.md

Briefing

The idea is to have a README.md with instructions of how to run the project and substitute the CRA Usage Guide.

Tasks

• Write README.md

Fix Dockerfile

Briefing

The current Dockerfile is failing to build.

Tasks

• Fix Dockerfile

Add a ISSUE_TEMPLATE.md

Briefing

GitHub offers a way to create ISSUE_TEMPLATE.md that could be used for standardization.

We could have one like:

### Briefing
Brief description of this issue or feature.

### Tasks

- [ ] Task 1
- [ ] Task 2

Tasks

• Create the ISSUE_TEMPLATE.md above

Setup CircleCI

Briefing

We will create some tests for the new API, but in the meantime we should configure Circle CI.

Tasks

• Setup CircleCI