GreenPen is an open-source assessment management suite, which allows teachers and students to view summative, standardised and formative data linked to specificiation points. GreenPen produces detailed analytics of syllabus mastery at the student, cohort and school level.
- Clone this repository with
git clone - If you have not already done so, install docker for your platform.
- Bring test that the initial setup works correctly with
docker-compose up --build. - Assuming this works correctly, you can now start developing.
- Clone the repository to your remote server using
git clone. - Edit the script
init-letsencrypt.shto include your email address, and set the correctstagingvariable (start with 1 for testing, then 0 when you've verified it's correct. - Run
chmod +x init-letsencrypt.shandsudo ./init-letsencrypt.sh - Run
docker-compose -f docker-compose.prod.yaml up -d --buildto bring up the server.
The GreenPen developers use PyCharm as their IDE. To add docker to your PyCharm installation, follow the instructions on the PyCharm website
- You can either use docker client to attach a shell to the terminal, or use PyCharm's 'run manage.py' task. Those confident with the use of docker can directly run the following command;
- Run
manage.py createsueruserto add yourself as a superuser to the system.
Please feel free to add to the project. It is strongly recommended that you ensure that all code is accompanied by unit tests, and that these all work correclty when running manage.py test GreenPen.