Skip to content

Latest commit

 

History

History
86 lines (50 loc) · 3.44 KB

README.md

File metadata and controls

86 lines (50 loc) · 3.44 KB

Improvement Proposal System "improvo" 🛠️

About The Project 📚

The "improvo" improvement proposal system is developed as part of a school exercise for students specializing in IT application development. The primary objective is to plan and design a user-friendly software solution for the submission and management of improvement proposals within an educational environment.

This project serves as a learning exercise, allowing students to explore and apply their skills in the development of a practical solution for real-world scenarios. 🎓

Planned Features 🚀

  • Two user groups: admin and User 👥
  • Planned submission and viewing of improvement proposals for all user groups 📝👀
  • Planned search functionality for proposals 🔍
  • Categories for proposals: General, classes, administrative, technical 🗂️
  • Admin can plan to create and manage new categories ➕🗂️
  • Planned proposal status: Submitted, in progress, completed, rejected 📊
  • Admin can plan to create and manage additional status options ➕📊
  • Planned commenting on improvement proposals for all user groups 💬
  • Planning for an optional upvote system for proposal evaluation 👍

Contributing 🤝

As this project is part of an educational exercise, contributions, issues, and feature requests are welcome. This project aims to provide a practical learning experience for students in the field of IT Application Development.

Technology Stack 🖥️

This project is planned to be realized using Django, a high-level web framework for Python, to facilitate the development of a robust and scalable system.

Usage 🐍

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

Prerequisites ☑️

Windows / Linux / macOS (untested)
Python 3.x
pip (Python package installer)
node.js

Installation 💾

Clone the repo:

git clone https://github.com/tobifrnk/improvo.git

Install:

run install.bat / install.sh / install.zsh in project folder

Use:

run run.bat / run.sh / run.zsh in project folder

run reset.bat / reset.sh / reset.zsh for a clean project reset

Keep in mind, after closing the server, you'll have 
to deactivate the virtual enviroment by yourself 
by running 'deactivate' or 'voff.bat /voff.sh / voff.zsh'

Screenshots 📸

image

image

image

image

image

image

image

image

image

image

License 📜

Distributed under the MIT License. See LICENSE for more information.

Project Link: https://github.com/tf482/improvo