You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-32Lines changed: 41 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,17 @@
1
-
LAST BIG PR implemented:
1
+
# News
2
2
3
-
- double-entry preparation
4
-
- 2 new backend apis (tx and sales-or-vat-tax)
5
-
- Blazor better token management
3
+
LAST PR implemented:
6
4
7
-
Next steps between:
5
+
- Aspire 9.0 (very minimal implementation without service discovery or test project)
6
+
- Now, you can run the apphost project and have fun
8
7
9
-
- vat-sales tax module implementation
8
+
Next steps or in progress:
9
+
10
+
- Vat-sales tax module implementation
10
11
- .Net 9 (Blazor adaptations)
11
12
- SingalR hub to trace tx status
12
13
- Blazor double-entry ui
13
-
- Aspire (re-test the thing)
14
+
- Aspire, enhance service defaults and see for discovery and maybe tests project
14
15
- will see...
15
16
16
17
# Ubik - Accounting
@@ -21,7 +22,7 @@ A .net8 project to manage double entry accounting. (it's the very beginning of a
21
22
22
23
Microservices arch and supports multi-tenants.
23
24
24
-
But for now, it's an experimental project that references a lot of things about .net 8 - Backend and Frontend sides of things -.
25
+
But for now, it's an experimental project that references a lot of things about .net 8 (9 soon) - Backend and Frontend sides of things -.
25
26
26
27
## Not ready for production
27
28
@@ -30,11 +31,23 @@ At this stage, **DO NOT USE THIS SYSTEM ON A PRODUCTION** environnement.
30
31
-**Don't forget to change all the "secrets" exposed here, and in the configuration files.**
31
32
-**Never re-use the Keycloak realm configuration file.**
32
33
33
-
## For the Kubernetes/Minikube guys
34
+
# Run - Debug
35
+
36
+
Choose between section 1), 2) or 3)
37
+
38
+
## 1) For the Aspire guys
39
+
40
+
You can run all the stuff with the host project:
41
+
42
+
`dotnet run --project .\src\Ubik.AppHost\Ubik.AppHost.csproj`
34
43
35
-
For detailed instructions on deploying locally with Minikube (full experience), please refer to the [local deployment guide](./deploy/deploy-local-readme.md).
44
+
Or, in Visual Studio, you can set the Aspire Host project as project startup and you will be able to play/debug with all the dependencies.
36
45
37
-
## Build and Run
46
+
## 2) For the Kubernetes/Minikube guys
47
+
48
+
For detailed instructions on deploying locally with Minikube, please refer to the [local deployment guide](./deploy/deploy-local-readme.md).
49
+
50
+
## 3) For the Docker guys
38
51
39
52
**At the root of the repository**, "Mount" the dependencies with Docker by running this command in your terminal:
40
53
@@ -49,9 +62,7 @@ For detailed instructions on deploying locally with Minikube (full experience),
49
62
> - Pgadmin: to admin your dbs if needed
50
63
> - Apis: backend apis (security/accounting) for integration testing
51
64
52
-
### Ready to play and debug
53
-
54
-
#### Run backend Apis or define a multiple projects startup
65
+
#### Run backend Apis or define a multiple projects startup to debug
55
66
56
67
`dotnet run --launch-profile https --project ./src/Ubik.Accounting.SalesOrVatTax.Api/Ubik.Accounting.SalesOrVatTax.Api.csproj`
57
68
@@ -69,9 +80,13 @@ For detailed instructions on deploying locally with Minikube (full experience),
69
80
70
81
`dotnet run --launch-profile https --project ./src/Ubik.Accounting.WebApp/Ubik.Accounting.WebApp.csproj`
71
82
72
-
And now (when all the stuff are up and running), you can access the very first version of a the Blazor 8 webapp here <https://localhost:7249>
83
+
## For All
84
+
85
+
After choosing your prefered way 1), 2) 3) you can access the Blazor app here:
73
86
74
-
### All the things are up
87
+
<https://localhost:7249>
88
+
89
+
# All the things are up
75
90
76
91
If you try to access the Blazor app, you will be redirected on a Keycloak login page
77
92
@@ -89,6 +104,12 @@ Try to log with different access rights and play with the only available "Accoun
89
104
90
105
Now you can run your preferred code editor and start to deep dive... (see below)
91
106
107
+
# Integration tests
108
+
109
+
If you want to contribute, see section "3) For the Docker guys" to be able to mount the dependencies and run the integration tests project. No time to update to Aspire Test and change all the related stuff (github actions etc.).
110
+
111
+
At the end, simply run `docker compose -f .\docker-compose.yml -f .\docker-integration-tests.yml up -d`, and you will be able to run the tests project.
112
+
92
113
## External libs
93
114
94
115
| Package | For what |
@@ -100,6 +121,8 @@ Now you can run your preferred code editor and start to deep dive... (see below)
100
121
|[LanguageExt.Core](https://github.com/louthy/language-ext)| use Either<Left, Right> pattern |
101
122
|[Masstransit](https://github.com/MassTransit/MassTransit)| message bus abstraction + inbox/outbox pattern |
102
123
124
+
Send some love on github to this projects...
125
+
103
126
## Yarp Proxy
104
127
105
128
-- Ubik.YarpProxy --
@@ -150,15 +173,11 @@ First you can maybe uncomment this lines in Ubik.Accounting.WebApp.csproj, if yo
150
173
</Target>
151
174
```
152
175
153
-
I don't know why, but my build fails in Github actions if I let this Tailwind instructions (related to the forms plugin). If someone has an idea...
**To use Tailwind in DEV**, you need to have node installed, Tailwind and Tailwind forms... I let you go on their site for installation instructions. Maybe, `npm install` command can be sufficient in the WebApp (server) project, cannot be sure because it seems to trigger a weird error in the dotnet build github actions.
157
177
158
178
| Package | For what |
159
179
|----------- | -------- |
160
180
|[BalzorPageScript](https://github.com/MackinnonBuck/blazor-page-script)| small tool that allows Tailwind to apply its Dark or Light theme on each page and component |
161
-
|[IdentityModel](https://github.com/IdentityModel)| Small extension to refresh token in OpenIdC |
162
181
163
182
Send some love on github to this projects...
164
183
@@ -167,29 +186,19 @@ Send some love on github to this projects...
0 commit comments