Skip to content

Commit

Permalink
docs: add configuration steps in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
misicode committed Jul 31, 2024
1 parent b24611d commit bc7820e
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .env.template
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Config Server Repository
CONFIG_SERVER_GIT_URI=your_config_server_git_uri
CONFIG_SERVER_GIT_PATH=your_config_server_git_path
CONFIG_SERVER_GIT_PATH=your_config_server_git_path # only if your ConfigServer repository is local
# JWT
JWT_SECRET_KEY=your_jwt_secret_key
# MongoDB
Expand Down
107 changes: 107 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,113 @@ Aplicación de microservicios desarrollado con Spring Boot del proyecto Purpost
| [![IntelliJ IDEA][intellijidea-badge]][intellijidea-url] | Entorno de desarrollo del proyecto | 2023.2 Ultimate Edition |


<!-- GETTING STARTED -->
## 🚀 Iniciando el proyecto

Para poner en funcionamiento una copia local de este repositorio, siga los siguientes pasos.

### Requisitos previos

Obligatorio
```txt
JDK >= 17.X
Maven >= 3.X
```

Opcional
```txt
Git
IntelliJ IDEA
Docker
```

### Instalación y configuración

1. Descargue o clone este repositorio.

```sh
git clone https://github.com/misicode/Purpost_Blog-Server
```

2. Instale todas las dependencias de cada microservicio.

```sh
cd [microservice-name]
mvn install
```

3. Descargue o clone el repositorio de configuración.

```sh
git clone https://github.com/misicode/PurPostBlog-ConfigServer
```

### Despliegue

**Manual**
1. En el microservicio `config-server-service`, declare la variable de entorno de ubicación de su repositorio de configuración. Por ejemplo:
1. Si el repositorio es local:

```env
CONFIG_SERVER_GIT_URI=file:///C:\Users\Usuario\Documents\purpost-config-server
```
2. Si el repositorio es remoto:
```env
CONFIG_SERVER_GIT_URI=https://github.com/misicode/PurPostBlog-ConfigServer
```
2. En su repositorio de configuración, reemplace las siguientes variables de entorno de los archivos `.yml` con sus credenciales respectivas.
```env
${JWT_SECRET_KEY} = your_jwt_secret_key
${IMAGE_MONGODB_URI} = your_image_mongodb_uri
${POST_MONGODB_URI} = your_post_mongodb_uri
${USER_MONGODB_URI} = your_user_mongodb_uri
${CLOUDINARY_CLOUD_NAME} = your_cloudinary_cloud_name
${CLOUDINARY_API_KEY} = your_cloudinary_api_key
${CLOUDINARY_API_SECRET} = your_cloudinary_api_secret
```
3. Levante cada microservicio.
**Con Docker**
1. Cree el archivo `.env` como copia del archivo `.env.template` e ingrese sus credenciales respectivas.
```env
# Config Server Repository
CONFIG_SERVER_GIT_URI=your_config_server_git_uri
CONFIG_SERVER_GIT_PATH=your_config_server_git_path # only if your ConfigServer repository is local
# JWT
JWT_SECRET_KEY=your_jwt_secret_key
# MongoDB
IMAGE_MONGODB_URI=your_image_mongodb_uri
POST_MONGODB_URI=your_post_mongodb_uri
USER_MONGODB_URI=your_user_mongodb_uri
# Cloudinary
CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name
CLOUDINARY_API_KEY=your_cloudinary_api_key
CLOUDINARY_API_SECRET=your_cloudinary_api_secret
```

2. Construya el ejecutable de cada microservicio.

```sh
cd [microservice-name]
mvn clean package -DskipTests
```

3. Construya y levante los contenedores de los microservicios.

```sh
docker compose up -d --build
```


<!-- LICENSE -->
## 💼 Licencia

Expand Down

0 comments on commit bc7820e

Please sign in to comment.