Skip to content

Commit

Permalink
README's update
Browse files Browse the repository at this point in the history
  • Loading branch information
MichiBaum committed Oct 16, 2024
1 parent c9cf474 commit 1992631
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@



This project is all about microservices and microfrontends.
This project is all about microservices. Frontend is currently build with Angular.
There are microservices build with spring, spring cloud and so forth.

## Available Microservices
## Modules
There are these microservices:
- [Admin Service](./admin-service/README.md)
- [Authentication Service](./authentication-service/README.md)
Expand All @@ -27,6 +27,11 @@ There are these microservices:
- [Website Service](./website-service/README.md)
- [Chess Service](./chess-service/README.md)

And these libraries
- [Authentication Library](./authentication-library/README.md)
- [Permission Library](./permission-library/README.md)
- [Usermanagement Library](./usermanagement-library/README.md)

## Release

### Maven release plugin
Expand Down Expand Up @@ -62,7 +67,7 @@ Build docker images:
# Single container
docker compose logs ´name´

### Change HOSTS file
### Change HOSTS file (for dev on local machine)
*Remember to take Backup before editing your `hosts` file, mistakes there can block your internet access or cause other network-related issues.*


Expand Down Expand Up @@ -93,6 +98,14 @@ File: */etc/hosts*

docker run --name microservices -e MYSQL_ROOT_PASSWORD=someRootPass -p 3306:3306 -d mysql:9.0.1

After that create the databases in the container.
The tables are created trough

spring
jpa:
hibernate:
ddl-auto: update

## License

[![GitHub license](https://badgen.net/github/license/MichiBaum/Microservices)](https://github.com/MichiBaum/Microservices/blob/master/LICENSE)
Expand Down
1 change: 1 addition & 0 deletions authentication-library/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Authentication library
1 change: 1 addition & 0 deletions permission-library/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Permission library
1 change: 1 addition & 0 deletions usermanagement-library/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Usermanagement library
3 changes: 3 additions & 0 deletions website-service/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
# Website Service


This service serves the build Angular files from the project [website](./../website/README.md).

0 comments on commit 1992631

Please sign in to comment.