Easy School

This is a school management system that uses Django Admin to do most of the work of managing students, fee submissions, teacher records etc..

Setting up Easy School is very easy.

Want to Use?

You can clone this branch and use it right now using any of the methods mentioned below

Building

It is best to use the python virtualenv tool to build locally:

> virtualenv venv
> source venv/bin/activate
> git clone https://github.com/ZeroCoolHacker/easy-school .

Then you navigate to the base directory of the project and install the requirements in your virtual environment

> cd easy-school/easy-school
> pip install -r requirements.txt

And finally you make migrations to the database, create a super user, and run the server

> python manage.py makemigrations
> python manage.py migrate
> python manage.py createsuperuser
> python manage.py runserver

Then visit http://localhost:8000 to view the app. Alternatively you can use foreman and gunicorn to run the server locally

> foreman start

Building with Docker

First run docker-compose to build the container:

docker-compose build

Then, run the following command to create the superuser:

docker-compose run web python manage.py createsuperuser

Finally, the Docker container can be launched with the following command:

docker-compose up

The server should be responding at 127.0.0.1:8000

Contributing

Just follow the steps above to setup your environment. Read the Contribution Guide If you have any more questions you can join the gitter room

To do

• Manage Students Record in admin
• Submit fees in admin
• Show last submitted fee along with students
• Link Students to different Courses
• Search the record by various fields
• Minimize the number of queries for each view
• Add Teachers Record to admin
• Add Teachers Salary Record to admin
• Export Data in csv format from admin
• Add graph comparing teacher salaries given vs student's fee collected

Licensing

This Project is Licensed under GLWTPL

Contributors ✨

Thanks goes to these wonderful people (emoji key):

ali madihi bidgoli 💻

mmoomocow 🐛 💻

davidkarabas 💻

adamzavacky 🎨 💻

Julian van Doorn 💻

Mohan Chhabaria 🎨 💻

This project follows the all-contributors specification. Contributions of any kind welcome!