ShopIt

An E-commerce Application based on Spring Boot as a Backend with Postgres Database and Kotlin as frontend.
Explore the docs »

View Demo · Report Bug · Request Feature · Download Application

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgments

About The Project

>> Click to view Figma Designs <<

This is an e-commerce application that will help you buy and sell and commercial product online and provide a excellent user-experience. You can buy any product with cash on delivery as well as online payment facilities. The razorpay payment gateway is used that provide super speed and highly secure online payments. Customer can add and remove the product from the cart and then directly pay for all the items added in the cart. The application also provides a wishlist facility where user can add the products and buy them later when they want.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you can use my APIs on setting up my project locally. To get a local copy up and running follow these simple steps.

Prerequisites

You only need to install the JAVA 17.0.5 LTS from Oracle, go to the following link and install for your operating system *

https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html

Installation

1. Get the JAVA 17.0.5: https://www.oracle.com/
2. Set up the postgres database (local database): https://www.postgresql.org/
3. Clone the repo

   git clone https://github.com/pranavbisaria/ShopIT-E-Commerce-App.git

4. Open the cloned folder using STS, IntelliJ Idea or any other IDE, and it will auto download all the configuration files.
5. Replace the database links, razorpay API keys of your own, twilio API keys, google Oauth2 API keys and AWS S3-Bucket API keys.
6. Run the project, the base URL for the project will be

   http://localhost:80/

7. Get the documentation for the various APIs at the following link

   http://localhost:80/swagger-ui/index.html

(back to top)

Usage

This project includes all the APIs related to provide various functionality for a E-Commerce website or application.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add, update and delete products
• Role based user model
  • Admin
  • Customer
  • Merchant
• Manage files and json input in the same API
• Multiple files in the same API
• Spring Boot Security
  • Component Based Security Model (2023)
  • JWT token (Access and Refresh Token)
  • Oauth2 Google Login
• Razorpay Payment Integration
• Asynchronous Method calling for faster API response
• Push Notification
  • Using websockets + stomp client
  • Using firebase
• Hosted on AWS EC2 VM
  • Springboot as a service

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Pranav Bisaria - @pranavbisaria29 - pranavbisariya29@gmail.com

Project Link: https://github.com/pranavbisaria/ShopIT-E-Commerce-App

(back to top)

Acknowledgments

• https://start.spring.io/
• https://www.baeldung.com/spring-boot
• https://www.baeldung.com/spring-boot-security-autoconfiguration
• https://spring.io/guides/gs/messaging-stomp-websocket/

(back to top)