diff --git a/README.md b/README.md index e37e4b1..07b1666 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,27 @@ -# Introduction -TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. +# myAi -# Getting Started -TODO: Guide users through getting your code up and running on their own system. In this section you can talk about: -1. Installation process -2. Software dependencies -3. Latest releases -4. API references +The **myai.ro** platform — a set of .NET microservices (CV matching, RAG, email, CV search, page +fetching, …) behind a web frontend + API. Part of the easySoft platform. -# Build and Test -TODO: Describe and show how to build your code and run the tests. +## Layout +Multiple services (`*-api`, `*-job`) + `web`, sharing a common bootstrap in +`startup-helpers/` (Serilog, Swagger, `.env`/Key Vault loading, middleware). See **CLAUDE.md** +for the full service map, dependency chain, and conventions. -# Contribute -TODO: Explain how other users and developers can contribute to make your code better. +## Run locally +```bash +docker compose up --build # or run individual services with: dotnet run --project +``` -If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files: -- [ASP.NET Core](https://github.com/aspnet/Home) -- [Visual Studio Code](https://github.com/Microsoft/vscode) -- [Chakra Core](https://github.com/Microsoft/ChakraCore) \ No newline at end of file +## Deploy +CI builds `registry.easysoft.ro/apps/myai-*:{staging,production}`; Watchtower rolls them out to +the **staging (`10.0.0.183`)** + **production (`10.0.0.248`)** Portainer stacks. Edge Caddy serves +**myai.ro** (prod) / **myai.easysoft.ro** (staging). + +## Logging +Every service: `ConfigureJsonSerilog(name, version)` → Serilog **Compact JSON** to stdout → Grafana +**Alloy** → **Loki**. No app metrics/traces (simple services). + +--- +See **CLAUDE.md** for the detailed solution guide and **ACCESS.md** (local, gitignored) for +infrastructure access.