add tools and update readme/todo
All checks were successful
Build and Publish / release (push) Has been skipped
Build and Publish / check-chart (push) Successful in 11s
Build and Publish / helm-release (push) Has been skipped

This commit is contained in:
2025-04-01 09:10:43 -04:00
parent 0b1826951e
commit b1102825fe
4 changed files with 23 additions and 7 deletions

View File

@ -25,32 +25,39 @@ Check out the [go-app framework](https://gitea.libretechconsulting.com/rmcguire/
## 📚 Getting Started
1. Install tools:
- Install make, protoc, and go using brew, apt, etc..
- Install protoc plugins (provided in go.mod tool()):
- `go get -v tool && go install -v tool`
1. **Rename your package:**
```sh
make rename NAME=my.gitremote.com/pathto/repo
```
2. **Review the config struct:**
1. **Review the config struct:**
Update and customize your app-specific configuration. This merges with go-app's configuration, providing logging, HTTP, and GRPC config for free.
3. **Generate a new JSON schema:**
1. **Generate a new JSON schema:**
```sh
make schema
```
- Ensure your structs have `yaml` and `json` tags.
- With the `yaml-language-server` LSP plugin, the schema will be auto-detected in your `config.yaml`.
4. **Compile proto files:**
1. **Compile proto files:**
```sh
make proto
```
- Add paths under `proto/` as necessary.
5. **Implement your application logic.**
1. **Implement your application logic.**
6. **Update Gitea CI configuration:**
1. **Update Gitea CI configuration:**
Modify parameters in `.gitea/workflows/ci.yaml` as needed.
1. Tag your release: `git tag v0.1.0` and push `git push --tags`
---
## 📂 Project Structure