A comprehensive school database management system designed to facilitate the tracking, updating, and management of student and staff data. Built using Python, MySQL, and Flask, this application offers a dynamic web interface for users to interact with the database easily.
- Manage Student Records: Add, update, and delete student details.
- Staff Management: Keep track of staff information, including qualifications, departments, and personal details.
- Class Assignments: Associate students with classes and teachers to particular subjects.
- Attendance Tracking: Record and view attendance for both students and staff.
Requirements:
- Python 3.x installed
- MySQL Server running locally or remotely with necessary credentials
- Flask installed in your Python environment
To install:
- Clone the repository from GitHub:
git clone https://github.com/Brendan5536/school-database-management.git
- Navigate to the cloned directory:
cd school-database-management
- Install the necessary Python packages:
pip install -r requirements.txt
- Import the MySQL database structure and initial data from
dataManage.sql
into your MySQL server. You can do this by accessing your MySQL Command-Line Client and executing:
source path/to/dataManage.sql;
Before running the application, you must configure your database connection settings. Open the config.py
file in your favorite editor and update the following lines with your MySQL server details:
MYSQL_DATABASE_USER = 'your_mysql_username'
MYSQL_DATABASE_PASSWORD = 'your_mysql_password'
MYSQL_DATABASE_DB = 'your_database_name'
MYSQL_DATABASE_HOST = 'your_host'
Replace 'your_mysql_username'
, 'your_mysql_password'
, 'your_database_name'
, and 'your_host'
with your actual MySQL username, password, database name, and host, respectively.
After completing the installation and configuration, you can run the application using Flask. From the project's root directory, execute:
flask run
By default, the flask app will run on http://127.0.0.1:5000/.
- Home Page: Navigate through the available options to manage students, staff, classes, and attendance.
- Add New Records: Use the forms to add new students, staff members, classes, or attendance records.
- View and Update: Access the list of existing records, where you can view details or choose to update or delete them.
To contribute to the project, follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
. - Push to the original branch:
git push origin <project_name>/<location>
. - Create the pull request.
Alternatively, see the GitHub documentation on creating a pull request.
If you want to contact me, you can reach me at brendan@jarmusz.com.
This project uses the following license: MIT.