Skip to content

Commit 032b42f

Browse files
committed
Merge branch 'master' of https://github.com/dbacilio88/archetype-api-microservices into feature/jdk-21
2 parents 85ca25b + 5931a95 commit 032b42f

File tree

4 files changed

+112
-41
lines changed

4 files changed

+112
-41
lines changed

README.md

Lines changed: 112 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,61 @@
1-
# archetype-api-microservices
1+
# 🎯 archetype-api-microservices
22

3-
archetype-api-microservices
3+
<!-- TOC -->
44

5-
## Clonar el Proyecto
5+
* [🎯 archetype-api-microservices](#-archetype-api-microservices)
6+
* [🧩 Descripción general](#-descripción-general)
7+
* [🔖 Características](#-características)
8+
* [📋 Requisitos](#-requisitos)
9+
* [🪛 Crear un proyecto](#-crear-un-proyecto)
10+
* [📀 Instalación](#-instalación)
11+
* [💻 Construir en Terminal bash](#-construir-en-terminal-bash)
12+
* [🖥️ Construir en Terminal cmd](#-construir-en-terminal-cmd)
13+
* [🧮 Estructura del proyecto](#-estructura-del-proyecto)
14+
* [🔧 Tecnologías Usadas](#-tecnologías-usadas)
15+
* [⚙️ Configuración rápida](#-configuración-rápida)
16+
* [🧰 Integración de dependencias](#-integración-de-dependencias)
17+
* [📦 Ejemplo de código](#-ejemplo-de-código)
18+
* [🧪 Uso](#-uso)
19+
* [👨🏻‍💻 Contribuciones](#-contribuciones)
20+
* [📞 Contacto](#-contacto)
621

7-
Para clonar este proyecto, utiliza el siguiente comando:
22+
<!-- TOC -->
823

9-
```bash
10-
git clone https://github.com/dbacilio88/archetype-api-microservices.git
11-
```
24+
# 🧩 Descripción general
25+
26+
Este arquetipo proporciona una estructura básica para iniciar proyectos en Java utilizando el framework Spring. Está
27+
diseñado para facilitar el desarrollo rápido y eficiente de aplicaciones web.
1228

13-
## Requisitos
29+
# 🔖 Características
30+
31+
## 📋 Requisitos
1432

1533
Asegúrate de tener instalado:
1634

1735
- Java 11 + (o la versión necesaria)
18-
- Maven 3.x
36+
- Maven 3.6 o superior
37+
38+
# 🪛 Crear un proyecto
1939

20-
## Construcción del Proyecto
40+
## 📀 Instalación
41+
42+
**Clonar el Proyecto**
43+
44+
Para clonar este proyecto, utiliza el siguiente comando:
45+
46+
```bash
47+
git clone https://github.com/dbacilio88/archetype-api-microservices.git
48+
```
2149

2250
```bash
2351
cd archetype-api-microservices
52+
```
53+
54+
```bash
2455
mvn clean install
2556
```
2657

27-
## Construir en Terminal bash
58+
## 💻 Construir en Terminal bash
2859

2960
```shell
3061
mvn archetype:generate \
@@ -40,7 +71,7 @@ mvn archetype:generate \
4071
-DinteractiveMode=false
4172
```
4273

43-
## Construir en Terminal cmd
74+
## 🖥️ Construir en Terminal cmd
4475

4576
```shell
4677
mvn archetype:generate ^
@@ -50,21 +81,86 @@ mvn archetype:generate ^
5081
-DgroupId=com.example ^
5182
-DartifactId=archetype-example ^
5283
-Dversion=1.0.0 ^
53-
-Dversion=1.0.0 ^
5484
-DpackageName=microservice/application ^
5585
-Dpackage=com.example ^
5686
-DinteractiveMode=false
87+
```
88+
89+
## 🧮 Estructura del proyecto
5790

5891
```
92+
Disk:.
93+
├───deploy
94+
├───docs
95+
│ └───collections
96+
└───src
97+
├───main
98+
│ ├───java
99+
│ │ └───com
100+
│ │ └───example
101+
│ │ └───microservice
102+
│ │ └───application
103+
│ │ ├───components
104+
│ │ │ ├───configuration
105+
│ │ │ ├───exceptions
106+
│ │ │ ├───interfaces
107+
│ │ │ ├───mappers
108+
│ │ │ └───utils
109+
│ │ ├───controllers
110+
│ │ │ ├───contracts
111+
│ │ │ └───implementations
112+
│ │ ├───dtos
113+
│ │ ├───repositories
114+
│ │ │ └───entities
115+
│ │ └───services
116+
│ │ ├───contracts
117+
│ │ └───implementations
118+
│ └───resources
119+
└───test
120+
├───java
121+
│ └───com
122+
│ └───example
123+
└───resources
124+
```
125+
126+
## 🔧 Tecnologías Usadas
127+
128+
| java | Spring Boot | Gradle | Maven | Branch |
129+
|:------:|:-----------:|:----------:|----------------|-------------|
130+
| jdk-11 | 2.* | gradle-8.5 | 3.6 o superior | [console]() |
131+
132+
## ⚙️ Configuración rápida
133+
134+
Incluye configuraciones predeterminadas para Spring Boot.
135+
136+
## 🧰 Integración de dependencias
59137

60-
## 👨🏻‍💻 Contributors
138+
Configuración básica de Maven para gestionar dependencias.
139+
140+
## 📦 Ejemplo de código
141+
142+
Incluye ejemplos de controladores, servicios y repositorios.
143+
144+
**Ojo**: Leer deploy.md del proyecto generado
145+
146+
# 🧪 Uso
147+
148+
Puedes agregar tus propios controladores, servicios y repositorios en las carpetas correspondientes. Modifica
149+
`application.properties` o `application.yml` para configurar tu aplicación según sea necesario.
150+
151+
# 👨🏻‍💻 Contribuciones
61152

62153
¿Cómo puedes ayudar?
63154

155+
¡Las contribuciones son bienvenidas! Si deseas contribuir a este arquetipo, por favor abre un issue o envía un pull
156+
request.
157+
64158
1. [ ] Prueba el arquetipo y compárteme tus impresiones.
65159
2. [ ] Contribuye con código, ideas o mejoras.
66160
3. [ ] Comparte este mensaje con tus colegas y en tus redes sociales.
67161

68-
Tu apoyo puede hacer una gran diferencia y juntos podemos construir algo increíble. ¡Espero contar contigo!
162+
Tu apoyo puede hacer una gran diferencia y juntos podemos construir algo increíble. 🚀 ¡Espero contar contigo!
163+
164+
# 📞 Contacto
69165

70-
[dbacilio88](https://github.com/dbacilio88)
166+
Para más información, puedes contactar a [dbacilio88](https://github.com/dbacilio88)

src/main/resources/archetype-resources/.mvn/wrapper/maven-wrapper.properties

Lines changed: 0 additions & 18 deletions
This file was deleted.
-42.4 KB
Binary file not shown.

src/main/resources/archetype-resources/gradle/wrapper/gradle-wrapper.properties

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)