Git Product home page Git Product logo

mjga-scaffold's Introduction

Make Java Great Again!

modern Lightweight Test Meticulous coding Meticulous coding

MJGA is a modern Java web scaffold built based on the following principles:

One philosophy

  1. Manages the entire lifecycle of an application and its environment through docker-compose.yml.
  2. Customizes all property variables through the .env file.

Out of box:

  1. Foundational business functions such as authentication, permission management, and cache abstraction.
  2. Code Check&Format, CI/CD Plugin, and Docker Integration, all ready to use out of the box.
  3. Comprehensive unit testing that is well-designed and isolates the runtime environment.

Modern, Configurable, Meticulous coding, Not-all-in-one

  1. Modern: technology choices closely follow the trends in the open-source community.
  2. Configurable: supports component selection and configuration on a web page.
  3. Meticulous coding: considers best practices for every variable, function, module, and component.
  4. Not-all-in-one: both now and in the future, MJGA will maintain its boundaries.

Database First

MIT License

Technology Version Description
OpenJdk 17
SpringBoot 3.2.1 Core framework
Jooq 3.18.6 Generates type-safe SQL queries
Gradle 8.4 Automation build tool
Pmd 6.55.0 Static code analysis tool
Spotless 6.18.0 Code formatting
... ... ...

Usage

Docker

Confirm default environment variables

# env will be applied to compose.yaml
less ${projectRoot}/.env

Install Docker Engine and start the container

cd ${projectRoot}
docker-compose up -d

Local

(Optional) Start on local machine

# confirm .env and make sure process can use it
nano/vim ${projectRoot}/.env
${projectRoot}/gradlew bootRun

Generate DB Mapping Source

# confirm .env and make sure process can use it
nano/vim ${projectRoot}/.env
# generate schema mapping codes
./gradlew generateJooq
# output ->
# projectRootDir/build/generated-src
# └── jooq
#    └── tables # table mapping
#       ├── daos # Data Access Layer
#       ├── pojos # mapping dto
#       └── records # jooq query record

More Document

Test coverage

cover

summary

🔗

portfolio

mjga-scaffold's People

Contributors

ccmjga avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.