Skip to content

Latest commit

 

History

History
146 lines (96 loc) · 4.99 KB

README.md

File metadata and controls

146 lines (96 loc) · 4.99 KB
Raw

Shopp App - Backend

Backend system provides restful API for web or mobile.

CircleCI

SonarCloud Bugs Coverage Lines of Code

In this project I'm demonstrating you the most interesting features of Spring Cloud Project for building microservice-based architecture.

Introduction 💗💎❤️

Welcome to the backend component of shopp-app backend (e-ecommerce). This Java Spring boot backend is designed to handle the server-side logic and data processing for my application.

Prerequisites 🌀

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

  • Java Development Kit (JDK) 17 or higher installed.
  • Build tool (Maven) installed.
  • Database system (e.g., MySQL8) set up and configured.
  • Liquibase Migration Database MySql8
  • Reactive Programming with WebFlux Reactor Spring Boot.
  • Hibernate, JPA
  • Docker build
  • Restfull API
  • PostMan Testing API and Client.
  • Send message and receiver using Kafka server, Zookeeper, Broker.
  • Redis cache database
  • Flyway migration database version

✅Features

  • Provides all the necessary and most basic APIs of a website or mobile app for Shopp App and E-Ecommerce

Getting Started

Follow these steps to set up and run the backend:

  1. Clone the repository:
   git clone https://github.com/hoangtien2k3/shopapp-backend.git

1. Navigate to the project directory:

  cd shopapp-backend

2. Build the project:

  # Using Maven
  mvn clean install

3. Configure the database:

  • Update application.yml with your mysql database connection details.

4. Run Docker (docker-compose)

  cd shopapp-backend
  
  #run docker-compose
  docker-compose up -d

5. Create DATABASE shopapp and add data demo: DATA-DEMO in database Docker

6. Run the application:

  # Using Maven
  mvn spring-boot:run

Databaes Mysql8

mysql-8

Swagger-ui

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

swagger-ui

PostMan Client

postman-project

Technologies Used

  • Java: The primary programming language.
  • Spring Boot: Framework for building Java-based enterprise applications.
  • Maven/Gradle: Build tools for managing dependencies and building the project.
  • Database: Choose and specify the database system used (e.g., MySQL8).
  • Other Dependencies: List any additional dependencies or libraries used.
  • Cache: Using redis cache db

API Documentation

Document the API endpoints and their functionalities. You can use tools like Swagger for automated API documentation.

Contributing

If you would like to contribute to the development of this project, please follow our contribution guidelines.

Alt

License

This project is licensed under the MIT License.

MIT License
Copyright (c) 2024 Hoàng Anh Tiến

Contributors ✨


Hoàng Anh Tiến
💻 🚧 🤔 🎨 🐛