https://github.com/ajaymahadeven/e-commerce-platform

This GitHub repository contains a fully functional skeletal implementation of an e-commerce application system designed to facilitate the sale of products. Specifically, the authors have chosen to demonstrate the system using an e-commerce platform for a book store. However, this system can be adapted to accommodate the sale of diverse products.
https://github.com/ajaymahadeven/e-commerce-platform

client-server client-server-architecture e-commerce-project git java maven mvc-architecture rest-api restful-api spring-boot spring-mvc

Last synced: 30 days ago
JSON representation

This GitHub repository contains a fully functional skeletal implementation of an e-commerce application system designed to facilitate the sale of products. Specifically, the authors have chosen to demonstrate the system using an e-commerce platform for a book store. However, this system can be adapted to accommodate the sale of diverse products.

• Host: GitHub
• URL: https://github.com/ajaymahadeven/e-commerce-platform
• Owner: ajaymahadeven
• License: mit
• Created: 2023-03-31T10:24:19.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-23T10:20:13.000Z (over 1 year ago)
• Last Synced: 2024-11-17T16:03:03.188Z (about 2 months ago)
• Topics: client-server, client-server-architecture, e-commerce-project, git, java, maven, mvc-architecture, rest-api, restful-api, spring-boot, spring-mvc
• Language: Java
• Homepage:
• Size: 47.2 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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 :



 Terminal folder - Terminal View

 src -  Back end development folder 





## SETUP AND INSTALLATION

 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   or  mvn 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 







---

## EXTRA FUNCTIONALITIES 



 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 





---

### 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.