Project Moore is a replacement for many of the UTN web applications. Built using Wagtail and the Django framework, Project Moore intends to replace obfuscated custom applications. This is why this project keeps a high regard to programming practice and documentation.
Any questions about the project can be send to the UTN system administrator.
Before contributing please read through our contribution guidelines.
Getting Started - Virtual Environment
To get started with Project Moore, follow these instructions to set up a development environment:
- Install Python 3, at least version 3.5 or up.
- Clone the repository.
source ./source_me.shto create a virtual environment.
pip install -r dev-requirements.txt
cd srcto enter the website directory.
./manage.py migrateto initialize the database.
./manage.py createsuperuserto create an admin user.
During development, you can run a test web server using
Getting Started - Docker
If you can use Docker, there is an alternative way to get your development environment all set up:
- Clone the repository.
docker -t moore .to create the moore image.
docker run -d -p 8000:8000 -v $(pwd):/var/www/moore/ --name moore mooreto start a new docker container.
docker exec -it moore python src/manage.py migrateto initialize the database
docker exec -it moore python src/ createsuperuserto create an admin user.
The Moore application is now available on
http://localhost:8000 and can be started
and stopped using
docker start moore and
docker stop moore.
Documentation for Project Moore is split up into two parts. All documentation regarding Project Moore's code base is located within the code. Like the rest of the UTN infrastructure, a global overview of the application is documented on docs.utn.se
These tests are run automatically using Travis CI. If, however, you want to run these tests locally you can run the following commands in the project root directory:
./src/manage.py test src- to test with our Django test suites
flake8 src- to run the flake8 style enforcer
Project Moore intends to be multilingual. The web application is available in both Swedish and English. Whenever any translatable text is added or changed it should be translated using translation files.
Within Project Moore we use American English.
To create translations for an app:
../manage.py makemessages -l sv
- This will create or update the files under
- Use poedit (or your favourite tool -- please do not use a plain text editor since those cannot handle all the subtleties) to fix the translations.
AGPL-v2.0, unless a different, usually external, license is provided within a folder or file.