doc: add README.md amd report examples

This commit is contained in:
Sosokker 2025-02-02 09:37:48 +07:00
parent 3d44f74d94
commit ad1b63103b
4 changed files with 39 additions and 0 deletions

39
README.md Normal file
View File

@ -0,0 +1,39 @@
# Create Report, where does it rain?
## Usage
**Requirement**
- [Docker](https://www.docker.com/products/docker-desktop/)
- [Openweather](https://openweathermap.org/) API Key
```bash
docker compose up --build --remove-orphans --force-recreate
```
Then, go to [http://localhost:8080/report/](http://localhost:8080/report/)
---
Manually run each service
- Run Go server
```bash
cd cmd
go mod download
go run main.go
```
- Run http server
```bash
cd nginx/web
python -m http.server 8000
```
Then, go to [http://localhost:8000/](http://localhost:8000/)
## Report example
![report/report1.png](report/report1.png)
![report/report2.png](report/report2.png)
![report/report3.png](report/report3.png)

BIN
report/report1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

BIN
report/report2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

BIN
report/report3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB