SchoolManagement

Web Application and API for the management of a high school database.

API Documentation

View the full API documentation here: Postman Documentation

Relational Model

Database Schema

Fork Instructions

Video tutorial

1. Click the 'Fork' button in the top right corner of the page to make a copy of this repo on your account

2. Head over to your copy of the repo and click the green 'Code' button and copy the repo URL

3. Open up your terminal and type git clone <paste URL here>

4. Move into the project folder with cd SchoolManagement

Run Instructions

1. Make sure you have Python and pip installed on your machine. Check that it installed correctly by typing pip --version
   
   I recommend using a virtual environment for Django but it's not necessary
   Virtual Environment Setup (Windows)
   Virtual Environment Setup (MacOS/Linux)
   
   

2. Inside the project folder there will be a requirements.txt file containing all the packages that need to be installed to run the Django app. This is based on a previous project I did, and we may not end up using them all
   
   Install them using the command: pip install -r requirements.txt
   
   

3. Finally, run the server with: python manage.py runserver
   
   Type in localhost:8000 in your browser to access the site
   Quit the server with CONTROL-C (COMMAND-C on MacOS) in the terminal

Access the Admin Page

First thing you'll want to do once you get the program running is create a superuser for yourself

1. Stop the server and run the command: python manage.py createsuperuser

2. Follow the instructions and enter your username, email and password (these are stored securely so feel free to use whatever password you want)

3. Run the server again and navigate to localhost:8000/admin and login with your new credentials

Make Contributions

Before pushing your code make sure it's up to date with the original repo.

1. Add the original repo as a remote, call it "upstream"
   
   git remote add upstream https://github.com/JacobCuke/SchoolManagement.git

2. Fetch to update your remote-tracking branches
   
   git fetch upstream

3. Make sure that you're on your master branch
   
   git checkout master

4. Update your local repo with the original master
   
   git rebase upstream/master
   
   

Now you can commit and push as normal

5. Add your changes to the staging area
   
   git add .

6. Commit them to your local repo
   
   git commit -m "Meaningful commit message"

7. Push them to your remote repo
   
   git push origin master
   
   

Now all you need to do is go create a Pull Request

8. Go to you GitHub profile and navigate to the repo containing your version of the project

9. Create a new pull request, and leave a short description of the modifications you made

10. I will see the pull request and after confirming there are no conflicts I will merge your changes into the original repo