This is a project made up of applications for the American University of Nigeria Office of Institutional Research and Effectiveness. The project was initiated to replace the existing paper-driven activities by the university's office of institutional research and effectiveness to save on costs and be more environmentally friendly.
This project is still in development.
The initial requirements for this project include:
- This is a django project and it was built with python 3.11.5.
- The RabbitMQ broker.
- Postgres Database.
All other requirements are found in the project's Requirements file.
To set up this project on a machine (for preview/development only), you will need to:
- Ensure a similar Python version (say 3.11.5) is installed on your machine.
- (Optional) You may want to create a separate virtual environment
- You may use pyenv along side pyenv virtualenv.
- Create the virtual env with
pyenv virtualenv 3.11.5 oire
- Download and unzip or clone the project.
cdinto the project directory.- Install the requirements with
pip install -r requirements.txt
- Set up the database. You can do it how you want or follow this guide.
- Copy example environment file with
cp env.example .env
- Create Goat (Test User) with
python manage.py creategoat
- Runserver with
python manage.py runserverrabbitmq-server(in another shell obviously)celery -A oire worker -l info(in another shell but the same environment/virtual environment.
- Go to
http://localhost:8000/. - Click on Faculty Course Evaluation.
- Login with the Goat.
- Good luck 🎉
Please don't forget give us feedback in form of issues. 👍
Ensure, you have setup this project for preview to be conversant with the requirements and other intricacies for this project.
To install this project, you can follow the procedures in the guide. Please read through to understand it all before attempting the installation.
Alternatively, you can follow the procedures for deploying a django application to production.
Creative Commons (CC-NC-ND)