Skip to content

JavaFamilyClub/jfoa

Repository files navigation

build publish docker docker-web codecov Codacy Badge Percentage of opend issues GitHub release GitHub repo size GitHub License Join the chat Chat on QQ

0. Preface

0.0 Environment

  • JDK: open JDK 1.8
  • Platform: Mac OS X, Linux, Windows

0.1 Security

jfoa's amqp, email and other password information are all encrypted by jasypt-spring-boot-starter, so if you want to start the project after fork, please replace it(quote with ENC(xxx) in ./runner/src/main/resources/application.yml) with your own service or contact me for the secret key. When starting the project, In one of two ways:

  • pass in the JVM startup parameter -Djasypt.encryptor.password=xxx.
  • configure it to the environment variable export JF_JASYPT_ENCRYPTOR=xxx

0.2 Online Demo

Please visit www.javafamily.club preview.

1. Build Project

1.1 Build Develop Environment

gradlew[.bat] clean build

1.2 Build Production Environment

gradlew[.bat] clean build -Pbuildenv=prod

2. Project Runner

2.1 Startup

gradlew[.bat] server
Or
gradlew[.bat] server -Pbuildenv=prod # Product Mode

2.2 Compile

gradlew[.bat] classes # Compile Java 
gradlew[.bat] web:watch # watch web
Or
gradlew[.bat] web:watch -Pbuildenv=prod # watch product mode

2.3 Release

2.3.1 Build Release Jar
gradlew[.bat] cleanAll bootJar -Pbuildenv=prod
2.3.2 Run Release Jar
java -jar javafamily-oa-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod

2.4 Docker

2.4.1 Build Docker Image
./buildDockerImage
2.4.2 Run Docker Container
docker run -d -p80:80 -p443:443 --name jfoa javafamily/jfoa:latest
2.4.3 See the logs
docker logs containerId

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Contributors

This project exists thanks to all the people who contribute. [Contribute].