Minimalist Java - 🚧 wip

👷🏗️ Under development

This project is under development and is not ready for use.

Minimalist Java is a collection of lightweight Java libraries aiming to simplify and streamline your Java development. This project is structured as a monorepo, containing multiple individual libraries that can be used independently or together for a cohesive development experience.

Modules

Minimalist Http API (http-api): Provides essential API functionalities for Java applications.
Minimalist Dependency Injection (di): A lightweight solution for dependency injection in Java.

Installation

To use minimalist-java in your Maven project, follow the steps below:

1. Authenticate with GitHub Packages

Before you can use or install packages from the GitHub Package Registry, you need to authenticate. GitHub Packages only supports authentication via the personal access token at this time.

Add the following to your ~/.m2/settings.xml:

<servers>
    <server>
        <id>github</id>
        <username>YOUR_GITHUB_USERNAME</username>
        <password>YOUR_PERSONAL_ACCESS_TOKEN</password>
    </server>
</servers>

Replace YOUR_GITHUB_USERNAME with your GitHub username and YOUR_PERSONAL_ACCESS_TOKEN with a personal access token that has the read:packages scope (also ensure you have the repo and write:packages scopes if you plan to publish packages).

2. Add the Repository

In your project's pom.xml, add the following repository:

<repositories>
    <repository>
        <id>github</id>
        <url>https://maven.pkg.github.com/giovannymassuia/minimalist-java</url>
    </repository>
</repositories>

Replace OWNER with the repository owner's username and REPO with the name of the repository.

3. Add the Dependency

Next, you can add the dependency to your project:

<dependency>
    <groupId>io.giovannymassuia.minimalist.java</groupId>
    <artifactId>http-api</artifactId>
    <version>LATEST_VERSION</version>
</dependency>

Replace LATEST_VERSION with the desired version of the library.

4. (Optional) Using the BOM

If you're planning to use multiple modules from minimalist-java, consider adding the BOM (Bill of Materials) to your project. It will help manage versions for you.

Add the BOM to your dependencyManagement section:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>io.giovannymassuia.minimalist.java</groupId>
            <artifactId>bom</artifactId>
            <version>LATEST_VERSION</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Now, when adding individual minimalist-java modules to your dependencies, you don't need to specify their versions:

<dependencies>
    <dependency>
        <groupId>io.giovannymassuia.minimalist.java</groupId>
        <artifactId>http-api</artifactId>
    </dependency>
    <dependency>
        <groupId>io.giovannymassuia.minimalist.java</groupId>
        <artifactId>di</artifactId>
    </dependency>
</dependencies>

Updating POMs versions

To update the versions of all POMs in the project, run the following command:

mvn versions:set -DnewVersion=NEW_VERSION

To revert the changes, run:

mvn versions:revert

Contributing

If you'd like to contribute to Minimalist Java, please read our contributing guidelines.

License

minimalist-java is licensed under the Apache License 2.0. See the LICENSE file for details.