Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ropable committed Oct 2, 2024
1 parent 1c1b86f commit 33915aa
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,35 @@ This project consists of the Integrated Business Management System
(IBMS) corporate application, used by the Department of Biodiversity,
Conservation and Attractions.

# Installation
## Installation

The recommended way to set up this project for development is using
[Poetry](https://python-poetry.org/docs/) to install and manage a virtual Python
environment. With Poetry installed, change into the project directory and run:

poetry install

To run Python commands in the virtualenv, thereafter run them like so:
Activate the virtualenv like so:

poetry run python manage.py
poetry shell

To run Python commands in the activated virtualenv, thereafter run them like so:

python manage.py

Manage new or updating project dependencies with Poetry also, like so:

poetry add newpackage==1.0

# Environment variables
## Environment variables

This project uses environment variables (in a `.env` file) to define application settings.
Required settings are as follows:

DATABASE_URL="postgis://USER:PASSWORD@HOST:PORT/DATABASE_NAME"
SECRET_KEY="ThisIsASecretKey"

# Running
## Running

Use `runserver` to run a local copy of the application:

Expand All @@ -38,13 +42,13 @@ Run console commands manually:

poetry run python manage.py shell_plus

# Docker image
## Docker image

To build a new Docker image from the `Dockerfile`:

docker image build -t ghcr.io/dbca-wa/ibms .

# Pre-commit hooks
## Pre-commit hooks

This project includes the following pre-commit hooks:

Expand Down

0 comments on commit 33915aa

Please sign in to comment.