/CMPE272_Team_KASH_Project

Primary LanguageJava

CMPE272_Team_KASH_Project

School Management: CMPE 272 - Enterprise Project

Project Introduction:

Project Objective:

The School Management Application aims to create a centralized and efficient platform for key administrative and academic processes in a school environment. This includes managing student records, attendance tracking, academic performance monitoring, communication between teachers and parents, class and exam scheduling, financial management, and library services. The application aims to streamline these tasks, enhance collaboration, and provide real-time insights through reporting and analytics. Ultimately, it seeks to improve the overall efficiency, transparency, and communication within the school community, contributing to a better educational experience for students, teachers, and parents.

Local Software Requirements

Make sure you have the following software installed on your local machine:

  • React.js
  • AWS CLI
  • IntelliJ
  • MySQL Workbench
  • JDK 11
  • Apache Maven
  • PostMan

Features

  • Manage Student
  • Manage Teacher
  • Manage Parent
  • Manage Course
  • Manage Attendance
  • Manage Assignments
  • Manage Grade

Local Project Configuration

How to Set Up and Run the Project Locally

  1. Clone the Repository:
$ git clone https://github.com/Harshil-V/CMPE272_Team_KASH_Project

$ cd CMPE272_Team_KASH_Project

Frontend

1. Change Directory to /frontend

$ cd frontend

2. Install Dependencies

$ npm i # or npm install

3. Initialize Amplify

$ amplify init # complete the steps

4. Add Amplify Auth

$ amplify add auth # complete the steps

Note: Use 'Default configuration' and 'Sign In with Username'

5. Push to Publish AWS Resouces Config for Frontend

$ amplify push

Note: This uses CloudFromation

6. Make any change to API Endpoint on the code

$ npm run dev # application will be accessible at `http://localhost:5173/``

Note: Update baseURL where needed

Backend (Spring Boot)

Note: Have a JDK installation on your system. Either set the JAVA_HOME environment variable pointing to your JDK installation or have the Java executable on your PATH.

This project uses JDK 11. To check your JDK version installed locally:

$ java -version

1. Change Directory to /backend

$ cd frontend

2. Run the below Maven cmd 

$ mvn clean install

3. Run the below Maven cmd to create a jar in target folder

$ mvn clean package

4. To run the Spring boot application using jar 

$ java -jar target/school-management-0.0.1-SNAPSHOT.jar

5. To run the Spring boot application using Maven 

$ $ mvn spring-boot:run