Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kavicastelo/maven-template
This is a sample maven package release as a project template. Don't hesitate to contribute the project with your marvels ideas.
https://github.com/kavicastelo/maven-template
java-17 maven template
Last synced: 7 days ago
JSON representation
This is a sample maven package release as a project template. Don't hesitate to contribute the project with your marvels ideas.
- Host: GitHub
- URL: https://github.com/kavicastelo/maven-template
- Owner: kavicastelo
- License: apache-2.0
- Created: 2024-06-12T12:31:36.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-06-12T13:40:36.000Z (8 months ago)
- Last Synced: 2024-12-04T06:07:47.457Z (2 months ago)
- Topics: java-17, maven, template
- Language: Java
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Maven Template
This project is a template for creating and deploying a Maven package. The package is hosted on GitHub Packages.
## Getting Started
These instructions will help you set up the project on your local machine for development and deployment purposes.
### Prerequisites
Ensure you have the following software installed:
- [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/javase-downloads.html)
- [Apache Maven](https://maven.apache.org/download.cgi)
- [Git](https://git-scm.com/)
### Installation
1. **Clone the Repository**
```sh
git clone https://github.com/kavicastelo/maven-template.git
cd maven-template
```
2. **Configure Maven**
Ensure your `settings.xml` is configured with your GitHub credentials. This file is usually located in the `.m2`
directory in your home directory.
```xml
github
your_github_username
your_github_password
```
3. **Build the Package**
Run the following command to build the project:
```sh
mvn clean install
```
### Deployment
To deploy the package to GitHub Packages, run:
```sh
mvn clean deploy
```
### Distribution Management
Ensure your `pom.xml` includes the correct `distributionManagement` section:
```xml
github
https://maven.pkg.github.com/kavicastelo/maven-template
github
https://maven.pkg.github.com/kavicastelo/maven-template
```
### Using the Package
To use this package in your own Maven project, add the following to your `pom.xml`:
1. Repository Configuration
```xml
github
https://maven.pkg.github.com/kavicastelo/maven-template
```
2. Dependency Declaration
```xml
com.example
maven-template
1.0-SNAPSHOT
```
### Contributing
1. Fork the repository.
2. Create your feature branch: `git checkout -b feature/my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin feature/my-new-feature`
5. Submit a pull request.
### License
This project is licensed under the Apache License, Version 2.0. See the [LICENSE](#LICENSE) file for details.
### Acknowledgements
- [GitHub Packages Documentation](https://docs.github.com/en/packages)
- [Maven Documentation](https://maven.apache.org/guides/index.html)