Supports data-driven research for the growth, progress, and welfare of urban areas to enable and inform decisions and policy.
Currently in Phase 1 of development
-
To prepare the web client, install its requirements with
cd web && npm i. -
Run the docker containers with
docker-compose up. Be sure to check that all containers were able to start and stay running successfully before continuing. -
While the containers are up, run the following commands in a separate terminal to prepare the database:
a. Run
docker-compose run --rm django ./manage.py migrate.b. Run
docker-compose run --rm django ./manage.py createsuperuserand follow the prompts to create your own user.c. Run
docker-compose run --rm django ./manage.py populateto use sample data.
- Run
docker-compose up. - You can access the admin page at port 8000: http://localhost:8000/admin/
- The user interface is on port 8080: http://localhost:8080/
- When finished, use
Ctrl+Cto stop the docker-compose command.
Occasionally, new package dependencies or schema changes will necessitate maintenance. To non-destructively update your development stack at any time:
- Run
docker-compose pull - Run
docker-compose build --pull --no-cache - Run
docker-compose run --rm django ./manage.py migrate
tox is used to execute all tests.
tox is installed automatically with the dev package extra.
When running the "Develop with Docker" configuration, all tox commands must be run as
docker-compose run --rm django tox; extra arguments may also be appended to this form.
Run tox to launch the full test suite.
Individual test environments may be selectively run. This also allows additional options to be be added. Useful sub-commands include:
tox -e lint: Run only the style checkstox -e type: Run only the type checkstox -e test: Run only the pytest-driven tests
To automatically reformat all code to comply with
some (but not all) of the style checks, run tox -e format.