sureness

(β˜… 877)

Dromara Sureness A efficient security framework focus on protection of API.

  • .gitignore
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • pom.xml
  • README.md
  • README_CN.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/dromara/sureness

Downloads the entire project code from GitHub to your computer.

cd sureness

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f samples/quarkus-sureness/src/main/docker/Dockerfile.fast-jar -t sureness .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 sureness

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Maven (Java)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java projects.
  • Maven The build tool used for the mvn command.
cd core

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

βœ… A BUILD SUCCESS message means it worked. The output is created under target/.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd home

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation