Coffee Utilities Package ☕

Project Status: ⏳ In progress

Documentation: 📖 JavaDoc

📝 Project description

Coffee Utilities Package (CUP) is a Java library that provides a set of utilities for Java developers. The main objective of this project is to facilitate the development of Java applications, providing a set of tools that can be used in various contexts. The project is divided into modules, each of which provides a set of utilities for a specific context. The modules are independent of each other, so you can use only the modules you need in your project. The project is open source and is available on GitHub. You can contribute to the project by submitting bug reports, feature requests, or code contributions. The project is licensed under the Apache License 2.0.

🤔 Problem definition

Java is a powerful programming language that is widely used in the software development industry. However, Java does not provide a complete set of utilities for developers. Developers often need to write their own utilities to perform common tasks such as reading and writing files, working with dates and times, and working with collections. This can be time-consuming and error-prone. The Coffee Utilities Package (CUP) project aims to provide a set of utilities that can be used by Java developers to perform common tasks more easily and efficiently.

👨‍💻 Technologies

⚙️ Configuration

Development

To use this project and modify the classes, you must first install the dependencies. To do this, follow these steps:

1. Clone the repository to your local machine.
2. Run the ./gradlew build command to download the dependencies.

External app

To use this project in an external application, you can add the following code snippet to your build.gradle file:

dependencies {
    implementation 'br.dev.rplus:cup:{LAST_VERSION}'
}

or in your pom.xml file:

<dependency>
    <groupId>br.dev.rplus</groupId>
    <artifactId>cup</artifactId>
    <version>{LAST_VERSION}</version>
</dependency>

🔧 Functionalities

✔️ Environment utilities.

✔️ Logger manager.

✔️ HTTP class for requests.

✔️ Object serialization and export in different file formats.

✔️ Date and time utilities.

✔️ Unique identifier generator.

👀 Observations

This project is not yet in its final version.

🚀 Future enhancements

✔️ File utilities.

✔️ Cryptography utilities.

✔️ Resource management.

✔️ And more...

License 🔑

The Apache License 2.0

Copyright ©️ 2024 - Rafael Camargo