This is a RESTful API and web interface (UI using ReactJS) for a Shopping system.
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.
- Spring FRAMEWORK
- Java 17
- JUnit 5
- Maven
- Git
- Restful Api
- Terminal folder - Terminal View
- src - Back end development folder
Terminal Usage or IDE Based For Backend :
- Clone the repository from the school Gitlab server.
- Run
mvn clean compile
to build the project. - Run
mvn test
to run the tests. - Run
mvn spring:boot run
ormvn org.springframework.boot:spring-boot-maven-plugin:run
to access the API. ( try both commands.) - Note : The port allocated for the API is : 8080 .
For Frontend :
- 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 - Run
npm i npm start
to start the GUI. Please make sure it is in the "frontend" folder
- Save to file.
- Load to file.
- Usage of Window Shopping ( Can view products without logging in. )
- There is always a starting admin account with the following credentials :
- username : admin
- password : admin
- 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.
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.