sthsuyash/KS-shop

KS-shop is a fullstack ecommerce web-application for practice.

KS shop

(latest version)

KS shop is an ecommerce fullstack web application project created with AngularJS and SpringBoot integrating mySQL database.

• Homepage

  

There are different versions of the application updated accordingly and kept in different branches according to versions and latest version is kept in development branch. You can view them in Release Plan

• Application Interaction

  

Table of Contents

• General Info
• Technologies
• Features
• Setup
• Feature Release Plan
• License

Technologies

Project is created with:

• AngularJS 14.2.6
• SpringBoot 2.7.4
• TypeScript 4.8.4
• mySQL 8.x
• Bootstrap 5.x
• SCSS
• npm 8.19.x
• node 16.18.x
• HTML5

Features

The features (to be) implemented in the project:

1. Show a list of products.
2. Add products to shopping cart (CRUD).
3. Shopping cart checkout.
4. User login/logout security.
5. Track previous orders for logged in users.

Setup

To run this project locally, perform the following steps:

git clone https://github.com/sthsuyash/ecommerce-angular-springboot.git ecommerce
cd ecommerce
mvn spring-boot:run
cd ecommerce-frontend
ng serve

Release Plan

This is release plan for backend. For frontend, navigate to the frontend README.

1) Release 1.0

• Show a list of products

• Development Process

  1. Setup database tables

  2. Create a spring boot starter project

  3. Develop entities: Product and ProductCategory

  4. Create REST APIs and Spring Data JPA Repositories and Spring Data REST Spring Data REST will expose all these endpoints for free, and we don't want that.

     • disable POST, PUT, DELETE methods

     • Possible Solutions

       1. Don't use Spring Data REST

          1. Manually create REST APIs using @RestController
          2. Manually define methods for access: @GetMapping
          3. But we lose the Spring Data REST support for paging, sorting, etc.

       2. Use Spring Data REST and disable the endpoints we don't want.

          1. Configure to disable HTTP methods like POST, PUT, DELETE

2) Release 2.0

• Add products to shopping cart(CRUD).
• Shopping cart checkout.

License

MIT License

Copyright (c) 2022 Suyash Shrestha

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.