GeoGuide

Quick Start

If you are using Docker, start here

Requirements

• Python >= 3 and pip
• Node.js >= 6 and npm
  • it's highly recommended install with nvm

Basics

Create and activate a virtualenv

$ sudo pip install virtualenv # if not installed
$ virtualenv env -p python3
$ source env/bin/activate

Install the required packages

$ pip install -r requirements-sqlite.txt
$ npm install

Set Environment Variables

$ cp .env.example .env

Generate a new APP_KEY

$ python generate_key.py

Copy and paste at APP_KEY in .env file

Create DB

$ python manage.py create_db

Compile JavaScript and CSS

$ npm run build

Get a dataset

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

Feel free to try another dataset.

Run the Application

Docker

$ ./deploy
$ docker-compose up

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

Or

$ 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

Testing

Without coverage:

$ python manage.py test

With coverage:

$ python manage.py cov