Giter Club home page Giter Club logo

milk-distribution-system's Introduction

Milk-distribution-system

This project is designed to handle the report when some schools needs Milk to be distributed to them

Minister adding Head of teacher and school name where Milk will be delivered. Screenshot 2023-12-16 160716

Distributor interface new

Head of teacher approving the order and give feedback to those who deliver Milk Screenshot 2023-12-16 161124

Approving orders on the order interface Screenshot 2023-12-07 160034

Adding new User to be able to use our system Screenshot 2023-12-16 180457

Inyange admin page to be to coordinate and monitor everything being done in the system Screenshot 2023-12-16 180933

View shcools added by Minister because He/she is the one who add schools where Milk will be delivered Screenshot 2023-12-16 181252

Documentation

ID: 23608 NAMES: Jean Plaubert RUKUNDO

Milk Distribution System

PROJECT REQUIREMENTS

THE PURPOSE OF THE PROJECT Coordinating and monitoring Milk being distributed in Schools for students to be able to access a cup of Milk in schools even though some student may be able to drink milk home but then each student at school get a cup of milk for health as future professionals, and also manage the schools, distributors and minister who is in charge of schools to make the work easier and automated.

EXPECTED OUTCOME

  • Manages to add schools
  • Manages Milk being delivered in schools
  • Manages Distributor being deliver milk in school
  • Manages Schools to approve milk being delivered.

SPECIFIC CONSTRAINTS OR LIMITATIONS

  • The system is not allowing anyone to register themselves to be able to use the system but then it allows admin to add users afterward user receive an email for login credentials to get Role Based Access Control as this system it’s for Inyange, schools, Ministers in charge of schools and Distributors, no one else.

FUNCTIONAL REQUIREMENTS

  • The system should have administrator to control the system and be able to add users in the system
  • The system should have ministers to have ability to add new schools to the system, including relevant details such as school name, address, contact information, and delivery schedule preferences.
  • The system should have Milk page so that admin can add any type of milk
  • View and manage a list of all registered schools.
  • The system should have distributors to have ability to update delivery schedules, routes, and quantities based on demand and logistics.
  • The system should have school page where to specify the quantity and type of milk required for each delivery
  • The system should have school page where access delivery schedules, track deliveries, and provide feedback on the quality of delivered products.

NON-FUNCTIONAL REQUIREMENTS

  • Implement logging mechanisms for admin to track system activities, facilitating auditing and traceability of actions performed by users.
  • The system should allow emails to be sent to users to get an access to the system.
  • Load testing : Conducting regular load testing to ensure the system can handle peak loads without performance issues.
  • Performance requirements ensuring responsiveness and scalability
  • The system code must be easy to read and understand, with clear naming conventions, comments, and documentation.
  • The system must be developed following best practices for code maintainability, such as using design patterns, avoiding code duplication, and keeping code complexity to a minimum.
  • The system must be able to perform its functions efficiently and without errors under different load conditions, such as high traffic or peak usage.
  • The system shall able to run on window 10 or window 11 without change in its behavior.

PROJECT PLAN

PROJECT PLAN

  • Project Initiation Phase (1 day)
  • Define project objectives,
  • Define scope
  • Define requirements.
  • Develop a high project level plan
  • Requirements gathering and analysis phase (1 day)
  • Conduct detailed requirements gathering sessions
  • Analyze existing processes and systems to identify gaps and improvement opportunities.
  • Document functional and non-functional requirements
  • Prioritize requirements based on their importance and feasibility.
  • System Design Phase (1 day)
  • Develop a detailed system architecture and design
  • Design Database Schema
  • Create wireframes and user interface mockups
  • Development Phase (7 days)
  • Implement the student management system based on the approved design
  • Develop module for student registration
  • Conduct regular sprints and iterations
  • Perform unit testing to ensure functionality and quality of individual components
  • Testing Phase (1 day)
  • Conduct system testing to verify end-to-end functionality of the system
  • Perform integration system to ensure smooth interactions between the module
  • Identify any identified issues or bugs
  • Deployment (1 day)
  • Prepare the production environment for the deployment

RESOURCES USED IN THE PROJECT

  • Project Team
  • Project manager
  • Software and Tools: Spring MVC
  • Integrated Development Environment (IDE): IntelliJ
  • Database Management System (DBMS): MySQL
  • Version Control System: Git
  • Training and Documentation:
  • Training Materials: guides and training videos
  • Documentation Tools: Google Docs for creating project documentation

DATABSE SCHEMA

Screenshot 2023-12-16 204740

USER DOCUMENTATION

Admin should login using email and password that he was assigned, and then starts to create minister who will manage schools and approve milk distribution from a certain distributor, and add schools. Schools will be added by minister and make an order for a school, then after school will approve that order and distributor will deliver the milk with a certain quantity. And when the milk reach to them they will give feedback.

TECHNICAL DOCUMENTATION

  • Architecture
  • The student registration systems follow the Model-View-Controller (MVC) architectural pattern
  • The backend is implemented using Java programming language and Spring boot framework
  • The frontend is developed using HTML, CSS and JavaScript
  • Development Environment
  • Operating system: Windows 11
  • IDE: IntelliJ
  • Database: MySQL
  • Backend Implementation
  • The backend is implemented using Java and Spring boot
  • The project is organized into different packages such as controllers, services, models and repositories.
  • Data persistence is achieved using HTML, CSS and JavaScript
  • Input validation and error handling are implemented using Spring validation and exception handling mechanisms
  • Frontend Implementation
  • The frontend is developed using HTML, CSS and JavaScript
  • Thyme leaf template engine is used for server-side rendering of dynamic webpages
  • Bootstrap is used for responsive
  • Client-side form validation is implemented using JavaScript
  • Database Implementation
  • The database is implemented using MySQL
  • The database Schema is used to store student information and their login credentials
  • Security
  • User authentication and authorization are implemented using spring security
  • Access control is enforced based on user role and permission
  • Deployment
  • Configuration files such as application.properties is used to specify database connection settings and other system properties.
  • Testing
  • Integration testing is conducted to test the interaction between different pages of the system.
  • Logging and Error handling
  • Custom error page or exceptions handlers are implemented to provide a user-friendly experience in case of errors.
  • Errors and exceptions are logged with appropriate severity and error messages.
  • Maintenance
  • The system is maintained using version control systems such as Git to track changes.
  • Regular updates and bug fixes are performed to ensure system stability and security.
  • System documentation is updated to reflect any changes or enhancements made to the system.

Admin Credentials

Minister Credentials

App Link

Here's the link: https://23608-inyange-milk-distribution-app.up.railway.app/

milk-distribution-system's People

Contributors

agwillmkawy1 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.