https://github.com/CIGIHub/opencanada

The opencanada.org website source
https://github.com/CIGIHub/opencanada

Last synced: 3 months ago
JSON representation

The opencanada.org website source

• Host: GitHub
• URL: https://github.com/CIGIHub/opencanada
• Owner: CIGIHub
• License: mit
• Archived: true
• Created: 2015-05-29T14:43:28.000Z (over 9 years ago)
• Default Branch: staging
• Last Pushed: 2021-05-26T18:10:20.000Z (over 3 years ago)
• Last Synced: 2024-05-21T13:53:06.364Z (8 months ago)
• Language: Python
• Size: 76.4 MB
• Stars: 14
• Watchers: 10
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-wagtail - OpenCanada.org

README

        
# opencanada

**[ARCHIVED]** Since OpenCanada was [transferred to the Canadian International Council](https://opencanada.org/opencanada-returning-home-to-the-cic/), this repository is no longer maintained.

The opencanada.org website source.

Use Python 3.6+ and Django 1.11.x for best results.

## Setup

  -  Set up a virtualenv for the project (python3 -m venv opencanada)

  -  Install the appropriate requirements

    -  for development: `pip install -r requirements/dev.txt`

## Required Environment Variables

SECRET_KEY - The django SECRET_KEY setting.

Set environment variable in bash

BASE_URL - Base URL to use when referring to full URLs within the

Wagtail admin backend. e.g. in notification emails. Don't include '/admin' or

a trailing slash.

You can put them in a `.env` file beside manage.py. We use

[django-dotenv](https://pypi.python.org/pypi/django-dotenv/1.4.1).

## Migrations

Run any migrations required

## Git Hooks

Git hooks are provided in the hooks folder.

To install the hooks:

  -  navigate to the .git/hooks/ directory

  -  run `ln -s ../../hooks/ `  

    -  for example `ln -s ../../hooks/pre-commit.py pre-commit`

### Pre-Commit Hook

Performs flake8 and isort checks before allowing commit.

## Running Tests

To run the unit tests:

  -  run `./manage.py test --settings=opencanada.settings.test`