Summary of Endpoints 📝

Prerequisites 🛠️

Before you begin, ensure that you have met the following requirements:

• Java Development Kit (JDK): Download from Oracle's official website or use OpenJDK.
• Maven: Download from Maven's official website.
• MySQL: Download from MySQL's official website.
• IDE: An Integrated Development Environment (IDE) such as IntelliJ IDEA or Eclipse IDE.
• STS Plugin (If you're using Eclipse): Install STS Plugin.

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:

   git clone https://github.com/Swarnotaj003/ShopKart-E-commerce-Website.git
   

4. Navigate into the project directory:

   cd ShopKart-E-commerce-Website
   

5. Configure Database Connection Settings: Open the application.properties file & update the database connection settings.

   # 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 file & update the project path.

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

   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:

   ./mvnw spring-boot:run
   

   On Windows, use:

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