- This project includes the following libraries requirements
This project aims to build a web app for a school system(a school management system), where schools can have access and control over how to manage their students information.
The goal of this project is to build a web application that provides access to students to easily access their information and academic results at the end of term.
The school portal is a django project that help provides a digital presence for a secondary + primary school system, The school teachers can view their information, update the marks of students in the respective subjects that they are teaching, and students are able to access their information and also print out a pdf file containing those information.
At the moment, the app will be built with anyone able to signup and login, but permissioins will be set so only authorized users(students/teacher) of the school will be able to acess the features of the app.
Documentation of the endpoints can be viewed at: swagger
At the moment, the school portal is still in its development(incubation) state, with just quite a few of the tasks done.
-
Setting up of the project
-
Creation of the neccessary models
-
Writing out the views for signup/login
-
Writing out the views for teachers to update subjects CA scores
-
Writing out views for students to select their respective subjects
Other neccessary models and features will be added as the project progresses.
Before setting up the project locally, ensure you have the following prerequisites installed:
- Python (>=3.11.4)
- Django
- Django Rest Framework
- A Database System (e.g., PostgreSQL, MySQL, SQLite) - Django Database Installation
-
Clone the repository:
git clone https://github.com/phurhard/SchoolPortal.git -
Change into the parent directory:
cd SchoolPortal -
Set up a virtual environment:
python3 -m venv venv -
Activate your virtual environment:
source venv/bin/activate -
Install the Python dependencies:
pip install -r requirements.txt -
Create a .env file and set necessary secret keys, send me a message for the secret keys here
-
Apply migrations to create the database schema:
python3 manage.py migrate -
Start the development server:
python3 manage.py runserver
The API should now be running locally at http://localhost:8000/.
- dev -> pr this branch for everything
backendrelated - main -> dont touch this branch, this is what is running in production!
SchoolPortal is open to contributions, but I recommend creating an issue or replying in a comment to let us know what you are working on first that way we don't overwrite each other.
- Clone the repo
git clone https://github.com/phurhard/SchoolPortal.git. - Open your terminal & set the origin branch:
git remote add origin https://github.com/phurhard/SchoolPortal.git - Pull origin
git pull origin dev - Create a new branch for the task you are working on, eg
TicketNumber/(Feat/Bug/Fix/Chore)/Ticket-title:git checkout -b ZA-001/Feat/Sign-Up-from - After making changes, do
git add . - Commit your changes with a descriptive commit message :
git commit -m "your commit message". - To make sure there are no conflicts, run
git pull origin dev. - Push changes to your new branch, run
git push -u origin feat-csv-parser. - Create a pull request to the
devbranch notmain. - Ensure to describe your pull request.
-
If you've added code that should be tested, add some test examples.
Under no circumstances should you merge a pull request on a specific branch to the dev or main branch, we each must await a review from the other person before any merge can be done.
| Type | Description | |
|---|---|---|
| feat | Features | A new feature |
| fix | Bug Fixes | A bug fix |
| docs | Documentation | Documentation only changes |
| style | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.) |
| refactor | Code Refactoring | A code change that neither fixes a bug nor adds a feature |
| perf | Performance Improvements | A code change that improves performance |
| test | Tests | Adding missing tests or correcting existing tests |
| build | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| chore | Chores | Other changes that don't modify, backend or test files |
| revert | Reverts | Reverts a previous commit |
Sample Commit Messages
chore: Updated README file:=choreis used because the commit didn't make any changes to the frontend or test folders in any way.feat: Added plugin info endpoints:=featis used here because the feature was non-existent before the commit.