CS5031 - Software Engineering Practices - P3

NAME

Online Shopping (Book Sales) System USING SPRING FRAMEWORK AND RESTFUL API

DESCRIPTION

This is a RESTful API and web interface (UI using ReactJS) for a Shopping system.

Authors and acknowledgement

Team Members :

        1) 220031985 -  Model, Service Layer and Controllers (Back-end), Terminal View, Code- Review, Report.
        2) 190010714 -  GUI, API , Report, Code -Review.
        3) 220031545 -  Tests (Front-end & Back-end), Terminal View, API.

---

Technologies Used

• Spring FRAMEWORK
• Java 17
• JUnit 5
• Maven
• Git
• Restful Api

---

FILE STRUCTURE :

1. Terminal folder - Terminal View
2. src - Back end development folder

SETUP AND INSTALLATION

Terminal Usage or IDE Based For Backend :

1. Clone the repository from the school Gitlab server.
2. Run mvn clean compile to build the project.
3. Run mvn test to run the tests.
4. Run mvn spring:boot run or mvn org.springframework.boot:spring-boot-maven-plugin:run to access the API. ( try both commands.)
5. Note : The port allocated for the API is : 8080 .
   

---

For Frontend :

1. Run java -jar Terminal-0.0.1-SNAPSHOT.jar to access the terminal view of the system. The jar file is in the "Terminal" folder
2. Run npm i npm start to start the GUI. Please make sure it is in the "frontend" folder

---

EXTRA FUNCTIONALITIES

1. Save to file.
2. Load to file.
3. Usage of Window Shopping ( Can view products without logging in. )
4. There is always a starting admin account with the following credentials :
   username : admin
   password : admin

---

NO OF TESTS WRITTEN : 73

---

CONTRIBUTION GUIDELINES :

• Clone the repository from the school Gitlab server.
• Create a new branch for your feature or bug fix.
• Write unit tests for your code.
• Implement your feature or bug fix.
• Ensure all tests pass.
• Commit your changes and push to your branch on the Gitlab server.
• Submit a merge request to merge your changes into the main branch.

---

License

This project is done part of coursework of CS5031 - Software Engineering Practice of the Computer Science Dept of University of St.Andrews.

This project is licensed under the MIT License. See the LICENSE file for more information.