Files
itpp-standards/templates/repo-readme.md
T

30 lines
735 B
Markdown

# {{PROJECT_NAME}}
> **Owner:** Germaine | **Status:** PLANNED
> **Last Updated:** YYYY-MM-DD
<One-paragraph summary of what this project does and why it exists.>
## Access
| Resource | URL | Location | Notes |
|---|---|---|---|
| <service name> | https://... | <server> | <how to auth> |
## Tech Stack
<Bullet list: Python 3.11, FastAPI, SQLite, Docker, etc.>
## Quick Start
```bash
git clone https://git.itpropartner.com/ippadmin/{{PROJECT_NAME}}.git
cd {{PROJECT_NAME}}
# how to run / deploy
```
## Related
- [itpp-infrastructure](https://git.itpropartner.com/ippadmin/itpp-infrastructure) — server inventory, DNS
- [itpp-standards](https://git.itpropartner.com/ippadmin/itpp-standards) — docs standards and templates