Skip to content

Latest commit

 

History

History
103 lines (64 loc) · 3.42 KB

README.md

File metadata and controls

103 lines (64 loc) · 3.42 KB
Raw

Online Divorce Assistant

Lifecycle:Stable

This is a Django project forked from the openshift/django-ex repository.

The Online Divorce Assistant was developed by the British Columbia Ministry of Attorney General to help self represented litigants fill out the paperwork for their divorce. It replaces existing fillable PDF forms with a friendly web interface.

The steps in this document assume that you have access to an OpenShift deployment that you can deploy applications on.

Local development

Prerequisites:

  • Docker
  • Docker Compose
  • Python 3.8
  • Keycloak secrets for the BC Gov Keycloak Dev instance. These can be obtained from a member of the eDivorce team or a Keycloak Realm Admin.
  • Node 14.x for the Vue application (newer versions create an incompatible lock file)

To run this project in your development machine, follow these steps:

  1. (optional) Create and activate a virtualenv (you may want to use virtualenvwrapper).

  2. Clone this repo:

    git clone https://github.com/bcgov/eDivorce.git

  3. Install dependencies:

    pip3.8 install -r requirements.txt

  4. Create an environment settings file by copying .env.example to .env (.env will be ignored by Git)

    cp .env.example .env

  5. Edit .env and set the following variables:

    DJANGO_SECRET_KEY
EFILING_HUB_KEYCLOAK_SECRET
EDIVORCE_KEYCLOAK_SECRET

  6. Create a development database:

    python3.8 ./manage.py migrate

  7. Load questions from fixtures:

    python3.8 ./manage.py loaddata edivorce/fixtures/Question.json

  8. If everything is alright, you should be able to start the Django development server:

    python3.8 ./manage.py runserver 0.0.0.0:8000

  9. Start up docker containers:

    docker-compose up -d

  10. Build the vue uploader

    cd vue
npm install
npm run build

  11. Open your browser and go to http://127.0.0.1:8000, you will be greeted with the eDivorce homepage. You can log in with the account you created in step 9.

SCSS Compilation

SASS compilation is now handled by the internal django-sass-processor package. In local development, it compiles *.scss files it finds into the same directory when they're loaded in the browser (thereafter it re-compiles on load when it detects changes by timestamp difference). The file is collected into the staticfiles directory during build, so doesn't add overhead in production.

OpenShift deployment

See: openshift/README.md

Data persistence

For local development a SQLite database will be used. For OpenShift deployments data will be stored in a PostgreSQL database, with data files residing on a persistent volume.

License

Copyright 2017 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.