Ecommerce Application

Purpose

The purpose of the E-commerce shopping application Server is to provide Functionality of online shopping using Graphql API.

Requirements

The fully fledged server uses the following:

• Work with JVM 17
• Language: Kotlin (version: 1.8.22)
• Build Tool: Gradle
• Framework: SpringBoot (version: 3.1.3)
• Editor: IntelliJ
• API: GraphQL (Altair or Postman)
• Database: PostgreSQL (pgAdmin)
• Deployment: Docker & AWS

Dependencies

There are a number of third-party dependencies used in the project. Browse the Gradle build.gradle.kts file for details of libraries and versions used.

The application exposes health endpoint (http://localhost:8087/api/healthcheck).

Setup

To check out the project and build it from source, do the following:

git clone https://github.com/mnaeem99/shopping-server.git

Building and deploying the application

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

  ./gradlew build

Running the application

Create the image of the application by executing the following command:

  ./gradlew assemble

Create docker image:

  docker-compose build

Run the distribution (created in build/install/ directory) by executing the following command:

  docker-compose up

This will start the API container exposing the application's port (set to 8087 in this template app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:8087/api/healthcheck

You should get a response similar to this:

  ok