leeyanzhe/llzw-api-gate repository overview

⁠Language: English | 中文文档⁠

Simple full-stack shopping site powered by Spring⁠ and Angular⁠

This is a Spring demo site designated for beginners, which is also my course project of Software Engineering at HIT.

Current project status:

Frontend: Releasing.

Backend: Releasing.

Online Demo: https://llzw.hitnslab.com⁠

⁠Status of Continuous Integration and Automatic Testing

Branch	Status
master
dev

⁠Prerequisites

• JRE Runtime: 9 or later
• MySQL: 8 or later, running on localhost:3306⁠, otherwise you should modify related information in application-dev.yml⁠

⁠Getting Started

Three options

Backend service will listen on localhost:8981⁠ by default

⁠Use Prebuilt JAR Package

Follow the intructions on Release Page⁠

⁠Use Our Offical Docker Image

You should have docker environment installed before using this option.

Two options

• Run a single backend service

  Pull our official image for api backend

  docker pull leeyanzhe/llzw-api-gate
  

  Copy

  Run

  docker run -d -p "8981:8981" leeyanzhe/llzw-api-gate
  

  Copy

• Run the production services bundle

  Pull this git repository

  git clone https://github.com/YanzheL/llzw.git
  

  Copy

  Enter the project directory and bring up the whole services bundle

  cd llzw
  docker-compose up -d --build
  

  Copy

⁠From Source

To compile the source, you need a valid JDK environment with version 9 or later.

Clone this project

git clone https://github.com/YanzheL/llzw.git

Build the package

./mvnw package -DskipTests

Run

java "-Dspring.profiles.active=dev" -jar target/*.jar

You may also run the test version with in-memory database if you do not have an external database.

java "-Dspring.profiles.active=test" -jar target/*.jar

⁠Features

• RESTful API Backend

• Angular Single Page Application

• Travis CI Continuous Integration and Automatic Testing

• Docker Integration

  Every commit to master and dev branch will trigger automatic builds on DockerHub, which produces Our Latest Docker Image⁠

  latest image tag targets for dev branch

  stable image tag targets for master branch

⁠Documentation

• API Documentation⁠

⁠Contributors:

⁠LLZW Front:

Located in web/ directory

@windwen⁠

@ZhangTong1999⁠

⁠LLZW Backend and Misc.

Located in api-gate/ directory together with other misc files.

Me⁠

@WennyXY⁠

⁠License

Apache License 2.0⁠