Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbacilio88/archetype-api-microservices
archetype-api-microservices
https://github.com/dbacilio88/archetype-api-microservices
archetype contibution gradle ideas java maven spring-boot
Last synced: 2 months ago
JSON representation
archetype-api-microservices
- Host: GitHub
- URL: https://github.com/dbacilio88/archetype-api-microservices
- Owner: dbacilio88
- License: apache-2.0
- Created: 2024-06-12T23:24:33.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-11-11T17:41:24.000Z (2 months ago)
- Last Synced: 2024-11-11T18:33:59.919Z (2 months ago)
- Topics: archetype, contibution, gradle, ideas, java, maven, spring-boot
- Language: Java
- Homepage:
- Size: 89.8 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎯 archetype-api-microservices
* [🎯 archetype-api-microservices](#-archetype-api-microservices)
* [🧩 Descripción general](#-descripción-general)
* [đź”– CaracterĂsticas](#-caracterĂsticas)
* [đź“‹ Requisitos](#-requisitos)
* [🪛 Crear un proyecto](#-crear-un-proyecto)
* [đź“€ InstalaciĂłn](#-instalaciĂłn)
* [đź’» Construir en Terminal bash](#-construir-en-terminal-bash)
* [🖥️ Construir en Terminal cmd](#-construir-en-terminal-cmd)
* [🧮 Estructura del proyecto](#-estructura-del-proyecto)
* [🔧 TecnologĂas Usadas](#-tecnologĂas-usadas)
* [⚙️ Configuración rápida](#-configuración-rápida)
* [🧰 Integración de dependencias](#-integración-de-dependencias)
* [📦 Ejemplo de código](#-ejemplo-de-código)
* [🧪 Uso](#-uso)
* [👨🏻‍💻 Contribuciones](#-contribuciones)
* [đź“ž Contacto](#-contacto)
# 🧩 Descripción general
Este arquetipo proporciona una estructura básica para iniciar proyectos en Java utilizando el framework Spring. Está
diseñado para facilitar el desarrollo rápido y eficiente de aplicaciones rest.
# đź”– CaracterĂsticas
## đź“‹ Requisitos
AsegĂşrate de tener instalado:
- Java OpenJDK 21
- Maven 3.6 o superior
- Git
| Herramienta | Version | Recurso |
|--------------|:-------:|-----------------------------------------------------------------------------------------------------------------------------------|
| Java OpenJDK | 21 | [resources](https://jdk.java.net/java-se-ri/21) |
| Maven | 3.6.2 | [resources](https://archive.apache.org/dist/maven/maven-3/3.6.2/) |
| Git | latest | [win](https://git-scm.com/downloads/win), [mac](https://git-scm.com/downloads/mac), [linux](https://git-scm.com/downloads/linux) |
# 🪛 Crear un proyecto
## đź“€ InstalaciĂłn
**Clonar el Proyecto**
Para clonar este proyecto, utiliza el siguiente comando:
```bash
git clone https://github.com/dbacilio88/archetype-api-microservices.git
```
```bash
cd archetype-api-microservices
```
```bash
mvn clean install
```
## đź’» Construir en Terminal bash
```shell
mvn archetype:generate \
-DarchetypeGroupId=com.bacsystem \
-DarchetypeArtifactId=archetype-api-microservices \
-DarchetypeVersion=1.1.0 \
-DgroupId=com.example \
-DartifactId=archetype-example \
-Dversion=1.0.0 \
-Dversion=1.0.0 \
-DpackageName=microservice \
-Dpackage=com.example \
-DinteractiveMode=false
```
## 🖥️ Construir en Terminal cmd
```shell
mvn archetype:generate ^
-DarchetypeGroupId=com.bacsystem ^
-DarchetypeArtifactId=archetype-api-microservices ^
-DarchetypeVersion=1.1.0 ^
-DgroupId=com.example ^
-DartifactId=archetype-example ^
-Dversion=1.0.0 ^
-DpackageName=microservice ^
-Dpackage=com.example ^
-DinteractiveMode=false
```
## 🧮 Estructura del proyecto
```
Disk:
├───deploy
├───docs
│ └───collections
├───gradle
│ └───wrapper
└───src
├───main
│ ├───java
│ │ └───com
│ │ └───example
│ │ └───microservice
│ │ └───application
│ │ ├───components
│ │ │ ├───configuration
│ │ │ ├───enums
│ │ │ ├───exceptions
│ │ │ │ └───handler
│ │ │ ├───interfaces
│ │ │ ├───mappers
│ │ │ └───utils
│ │ ├───controllers
│ │ │ ├───contracts
│ │ │ └───implementations
│ │ ├───dtos
│ │ ├───repositories
│ │ │ └───entities
│ │ └───services
│ │ ├───contracts
│ │ └───implementations
│ └───resources
└───test
├───java
│ └───com
│ └───example
└───resources
```
## 🔧 TecnologĂas Usadas
| java | Spring Boot | Gradle | Maven | Branch |
|:----------:|:-----------:|:----------:|----------------|------------------------------------------------------------------------------------------------|
| openJDK-21 | 3.* | gradle-8.5 | 3.6 o superior | [console](https://github.com/dbacilio88/archetype-api-microservices/tree/spring-boot-3-jdk-21) |
## ⚙️ Configuración rápida
Incluye configuraciones predeterminadas para Spring Boot.
## 🧰 Integración de dependencias
Configuración básica de Maven o Gradle para gestionar dependencias.
## 📦 Ejemplo de código
Incluye ejemplos de controladores, servicios y repositorios.
**Ojo**: Leer deploy.md del proyecto generado
# 🧪 Uso
Puedes agregar tus propios controladores, servicios y repositorios en las carpetas correspondientes. Modifica
`application.properties` o `application.yml` para configurar tu aplicaciĂłn segĂşn sea necesario.
Nota: ejecutar el componente o aplicaciĂłn en perfil **`dev`**
# 👨🏻‍💻 Contribuciones
ÂżCĂłmo puedes ayudar?
¡Las contribuciones son bienvenidas! Si deseas contribuir a este arquetipo, por favor abre un issue o envĂa un pull
request.
1. [ ] Prueba el arquetipo y compárteme tus impresiones.
2. [ ] Contribuye con cĂłdigo, ideas o mejoras.
3. [ ] Comparte este mensaje con tus colegas y en tus redes sociales.
Tu apoyo puede hacer una gran diferencia y juntos podemos construir algo increĂble. 🚀 ¡Espero contar contigo!
# đź“ž Contacto
Para más información, puedes contactar a [dbacilio88](https://github.com/dbacilio88)