ShopKart-E-commerce-Website

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #machine-learning #macos #nodejs #awesome #kubernetes #security #pytorch #ios #openai #open-source

ShopKart-E-commerce-Website

(★ 4)

A simple e-commerce website implemented using the Spring Boot framework in Java. This is a group project assigned under "Information Processing for Web" in 5th semester of BTech, University of Calcutta

ShopKart-E-commerce-Website Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ShopKart : E-commerce Website

## About 💬
This is a simple e-commerce website implemented using the `Spring Boot` framework in Java, by a group of five members, namely `Spring Spartans`. This group project is assigned under `Information Processing for Web` in 5th semester of BTech (IT), `University of Calcutta`

Link to the website - [https://shopkart-e-commerce-website.onrender.com](https://shopkart-e-commerce-website.onrender.com)

## Version History 🚩
![Version](https://img.shields.io/badge/Version%20no.-v2.0-blue)  ![Type](https://img.shields.io/badge/Version%20type-Stable-005f00)  ![Commit No.](https://img.shields.io/badge/Released%20on-Commit%20no.%20128-orange)

![Version](https://img.shields.io/badge/Version%20no.-v1.0-blue)  ![Type](https://img.shields.io/badge/Version%20type-Beta-ffc107)  ![Commit No.](https://img.shields.io/badge/Released%20on-Commit%20no.%2075-orange)

## Tech Stack 👨‍💻
![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=flat&logo=openjdk&logoColor=white)
![Spring Boot](https://img.shields.io/badge/Spring%20Boot-6DB33F?style=flat-square&logo=spring&logoColor=white)
![MySQL](https://img.shields.io/badge/MySQL-4479A1?style=flat-square&logo=mysql&logoColor=white)
![JSP](https://img.shields.io/badge/JSP-FFB800?style=flat-square&logo=java&logoColor=white)
![CSS](https://img.shields.io/badge/CSS-1572B6?style=flat-square&logo=css3&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=flat&logo=javascript&logoColor=%23F7DF1E)
![Maven](https://img.shields.io/badge/Maven-C71A36?style=flat-square&logo=apache-maven&logoColor=white)
---

## Key Features 🌟
1. `Customer Management` - Login, Sign Up, View & Update Profile
2. `Product Catalog` - Display of products, Search by name, Filter by category
3. `Shopping Cart` - Add products to cart, Increase & decrease quantity
4. `Order Management*` - Place orders from cart, Buy again, Cancel orders, Detailed order list & summary
5. `Admin Dashboard` - Login (with a security key), Sales insight through analytics, Add or update products, View customers, Update orders

> \* This project is purely made for educational purpose and not meant to be deployed for commercial production. It assumes that payments are made instantly on placing orders as this project is not integrated with a payment gateway.
---

## Summary of Endpoints 📝

| Endpoint                              | View Rendered                      |
|---------------------------------------|------------------------------------|
| `/`                                   | Login page for customer            |
| `/signup`                             | Sign-up page for customer          |
| `/update`                             | Form to update customer profile    |
| `/product`                            | Product Catalogue                  |
| `/product/category/{category}`        | Filter products by category        |
| `/product/search?prefix={prefix}`     | Search results for products by name|
| `/product/{id}`                       | Product details                    |
| `/cartitem/cart`                      | Customer's cart                    |
| `/order/history`                      | Customer's order history/list      |
| `/order/summary/{id}`                 | Summary of order placed            |
| `/admin`                              | Login page for Admin               |
| `/admin/dashboard`                    | Admin Dashboard                    |
---

## Prerequisites 🛠️
Before you begin, ensure that you have met the following requirements:
- **Java Development Kit (JDK)**: Download from [Oracle's official website](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html) or use [OpenJDK](https://openjdk.java.net/install/).
- **Maven**: Download from [Maven's official website](https://maven.apache.org/download.cgi).
- **MySQL**: Download from [MySQL's official website](https://dev.mysql.com/downloads/mysql/).
- **IDE**: An Integrated Development Environment (IDE) such as `IntelliJ IDEA` or `Eclipse IDE`.
- **STS Plugin (If you're using Eclipse)**: [Install STS Plugin](https://marketplace.eclipse.org/content/spring-tools-4-aka-spring-tool-suite-4).
---

## Cloning the Repository 📥
To clone the repository, follow these steps:
1. Open your terminal (Command Prompt, PowerShell, or any terminal emulator).
2. Navigate to the directory where you want to clone the project.
3. Run the following command:
   
   ```bash
   git clone https://github.com/Swarnotaj003/ShopKart-E-commerce-Website.git
   ```
   
4. Navigate into the project directory:
   
   ```bash
   cd ShopKart-E-commerce-Website
   ```
    
5. **Configure Database Connection Settings**: Open the [`application.properties`](src/main/resources/application.properties) file & update the database connection settings.
   
    ```properties
    # Database connection settings
    spring.datasource.url=jdbc:mysql://${DATASOURCE_HOST}:${DATASOURCE_PORT}/${DATASOURCE_DB_NAME}
    spring.datasource.username=${DATASOURCE_USER}
    spring.datasource.password=${DATASOURCE_PASSWORD}
    ```
    Replace the environment variables with the corresponding credentials of your MySQL connection*.
    
6. **Setup your Project Path**: Open the [`application.properties`](src/main/resources/application.properties) file & update the project path.
   
   ```properties
   # Settings for uploading files  
   spring.servlet.multipart.enabled=true
   file.project-path=${PROJECT_PATH}
   file.image-path=uploads
   ```
   Replace the environment variable with the our own path to the project folder*.
   > \* You may create a `.env` file to store the values of these environment variables, which should be updated to `Run configurations` before executing the project.
---

## Executing the Project 💻

### Using Maven Wrapper 
The Maven Wrapper allows you to run Maven commands without needing to install Maven on your machine. Follow these steps to run the Spring Boot application using the Maven Wrapper:
1. **Open your terminal**: Make sure you have your terminal (Command Prompt, PowerShell, or any terminal emulator) open.
2. **Navigate to the project directory**: If you are not already in the project directory, use the `cd` command to navigate to it. For example:
   
   ```bash
   cd path/to/your/ShopKart-E-commerce-Website
   ```
   
3. **Run the application using the Maven Wrapper**: Use the following command to build and start the application:
   
    ```bash
    ./mvnw spring-boot:run
    ```
    On Windows, use:
    ```bash
    mvnw spring-boot:run
    ```
    
4. Wait for the application to start. You should see output in the terminal indicating that the application is running, along with the port number (default is 8080).
5. Once the application starts, open your web browser and navigate to:
   
     ```
     http://localhost:8080
     ```
     
### Using an IDE 
You can also run the Spring Boot application directly from your IDE. Follow these steps based on your preferred IDE:
1. Launch the IDE & import the project.
2. Locate the main application class named [`ShopkartApplication.java`](src/main/java/com/springspartans/shopkart/ShopkartApplication.java) in the `src/main/java` directory.
   - Right-click on the main class file and select `Run As` > `Spring Boot Application`.
3. Once the application starts, open your web browser and navigate to:
   
     ```
     http://localhost:8080
     ```

ShopKart-E-commerce-Website

ShopKart-E-commerce-Website Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ShopKart-E-commerce-Website

ShopKart-E-commerce-Website Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README