School X

📗 Table of Contents

• Smart School
• 📗 Table of Contents
• 📖 SchoolX
  • Tech Stack
  • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments -->
  • 📝 License

📖 SchoolX

SchoolX is a desktop application for schools to track their income and revenue. It also includes a database for storing data locally and visualization it. The GUI was built on KIVY with Material design.

Tech Stack

Backend

• Python

GUI

• KivyMD

Database

• SQLite

Visualizations

• Matplotlib

Key Features

• Register students into a class
• Register teachers with their salary grades
• Configure the semester
• Record expenses made and who made authorised them
• Record fees paid and by whom
• Show record of learners who have made full or part payment of fees
• Keep data on alumni

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

• In order to run this project you need:

• git: A tool for managing source code

• Visual Studio Code: A source code editor

Setup

Clone this repository to your desired folder:

Example commands:

  git clone https://github.com/coderacheal/Smart-School.git
  
  cd Smart-School

Install

• Make sure you have set up a virtual environemnt for this project
• Install the appropriate versions of the packages used in this project from the requirements.txt file

Run pip install -r requirements.txt

Usage

• Run python main.py for the app to start
• Create a user and begin interacting with the app

👥 Author

👤 Racheal Appiah-kubi

• GitHub: @coderacheal
• LinkedIn: racheal-appiah-kubi

(back to top)

🔭 Future Features

• Make app available online as a web app
• Show visualization of the data on expenses and income

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a start and share it with your friends.

(back to top)

🙏 Acknowledgments -->

I would like to appreciate the python community - those that came before us and paved the way

(back to top)

📝 License

This project is MIT licensed.

(back to top)