Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 2.22 KB

README.md

File metadata and controls

84 lines (59 loc) · 2.22 KB
Raw

SchoolwebApp: A Comprehensive School Management System

Welcome to SchoolwebApp, a robust and user-friendly school management system designed using Java's Spring Boot, Maven, and backed by MySQL. Built with N-Tier Architecture, our goal is to provide schools with a seamless way to manage their day-to-day operations.

Features

  • User Registration: New users can quickly register to access the system.
  • Login System: Secure and easy login for all users.
  • N-Tier Architecture: Ensuring separation of concerns for better maintainability.
  • Customizable Database: Easily integrate your database of choice.

📖 Note: To get started with the project, clone the repository and set your preferred database in the application.properties file.

Getting Started

Prerequisites

  • Java JDK (Version 17 or later)
  • Maven (Version 3.8.6 or later)
  • MySQL (Or your choice of database)

Setting up the Project

  1. Clone the repository from GitHub:

    git clone https://github.com/DamiGbot/SchoolWebPage.git

    Press enter to start the clone process.

  2. Navigate to the cloned repository:

    cd path_to_cloned_repo

  3. (Optional) Open the project in your preferred IDE.

  4. Update the application.properties file with your database details.

  5. Build and run the application:

    mvn clean install
mvn spring-boot:run

Contributing to the Project

We welcome contributions! Here's how you can help:

  1. Checkout to the main branch:

    git checkout main

  2. Pull the latest changes:

    git pull origin main

  3. Create a new branch for your features/changes:

    git checkout -b branch_name

  4. Make your changes and stage them:

    git add .

  5. Commit your staged changes:

    git commit -m "commit_message"

  6. Push your branch to the repository:

    git push --set-upstream origin branch_name

Please ensure your code adheres to our coding standards and guidelines. It's also a good idea to check if there's an existing issue related to your contribution before starting.

Acknowledgments

  • A big thanks to all our contributors and supporters!