Skip to content

Commit ad5e82c

Browse files
committed
docs: Update README.md
Complete development/deploy workflow
1 parent ffbab97 commit ad5e82c

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@
66

77
### Build
88

9-
Using Docker:
10-
```bash
11-
docker run --rm -it -v ~/.m2:/root/.m2 -v $(pwd):/workspace -w /workspace maven:3.6.3-jdk-11 mvn clean package
12-
```
13-
149
```bash
1510
./mvnw clean package
1611
```
@@ -61,14 +56,22 @@ Edit your `hosts` file (`/etc/hosts`):
6156

6257
#### Start containers
6358

64-
1. Ensure the `users-management-api` Docker image has been built, run `mvn package` in the `users-management-api` directory, if needed
59+
1. Build the `users-management-api` Docker image (in the `users-management-api` directory):
60+
```bash
61+
./mvnw clean package
62+
```
6563

66-
2.
64+
Set the `APP_USER_CREATION_IP_CHECK_ENABLED` environment variable to `false` to disable IP check on user creation (`docker-compose.yml`)
65+
66+
2. Build the `users-management-ui` Docker image (in the `users-management-ui` directory):
6767
```bash
68-
docker-compose up -d
68+
npm install && npm run build-prod && npm run docker:build
6969
```
7070

71-
3. Set the `APP_USER_CREATION_IP_CHECK_ENABLED` environment variable to `false` to disable IP check on user creation
71+
3. Run
72+
```bash
73+
docker-compose up -d
74+
```
7275

7376
This `docker-compose.yml` file starts 5 containers:
7477
- Traefik proxy
@@ -77,9 +80,9 @@ This `docker-compose.yml` file starts 5 containers:
7780
- RabbitMQ broker
7881
- UI
7982

80-
- Access the UI at `http://localhost`
83+
4. Access the UI at `http://localhost`
8184

82-
- Access the API documentation at `http://api.localhost/swagger-ui.html`
85+
5. Access the API documentation at `http://api.localhost/swagger-ui.html`
8386

8487
You can access the RabbitMQ dashboard at `http://broker.localhost`
8588

@@ -142,7 +145,7 @@ As there is only one entity involved in this small application, there is no need
142145

143146
2. Build Angular application:
144147
```bash
145-
npm install && start build-prod
148+
npm install && npm run build-prod
146149
```
147150

148151
3. Don't forget to set the `APP_USER_CREATION_IP_CHECK_ENABLED` environment variable to `false` if you want to disable IP check on user creation (`docker-compose.yml`)

0 commit comments

Comments
 (0)