template/project-readme.md.jinja at main · learnfrombasic/template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# 🔐 {{ microservice_name }}

{{ project_description }}

## 📚 Documentation

- [API Documentation](http://localhost:{{ port }})

## 🚀 Usage

Docker image is available at {% if registry_url %}[{{ registry_url }}/{{ microservice_name }}]({{ registry_url }}/{{ microservice_name }}){% else %}your registry{% endif %}.

For edge device, you can use the ARM64 image from {% if registry_url %}[{{ registry_url }}/arm64/{{ microservice_name }}]({{ registry_url }}/arm64/{{ microservice_name }}){% else %}your registry{% endif %}.

1. Set the environment variables in the `.env` file.
2. Run by docker compose. Docker compose file is in the root directory.

## 💻 Development

1. Install the dependencies:
```bash
uv sync
```
2. Activate the virtual environment:
```bash
source .venv/bin/activate
```
3. Set the environment variables in the `.env` file.
4. Run the development server:
```bash
fastapi dev app/main.py --host 0.0.0.0 --port {{ port }}
```

## ℹ️ Information

- 👨‍💻 Maintainer: {% if maintainer_url %}[{{ maintainer_name }}]({{ maintainer_url }}){% else %} {{ maintainer_name }} {% endif %}
- 🏷️ Version: {{ version }}