Update README.md

master
link 2024-02-14 16:51:52 +10:00
parent be034538ea
commit f4a6a1d761
1 changed files with 11 additions and 0 deletions

View File

@ -50,6 +50,17 @@ So as the idea grows in my mind, I think I might end up slowly transitioning mos
I will have to strike a balance between the two, having good documentation is key I believe.
Though I am enjoying using vite to handle the vanilla html/js and bundling dependencies.
## Structure
A generally standard golang project structure:
- `handlers`: Functions for handling the api requests.
- `models`: Structs for representing data in the DB or application state
- `frontend`: Vanilla JS Vite project
- `partials`: Go Templ components which aren't full page views, could of been called components
`main.go` currently resides in the root of the project but am considering moving it to `cmd/server/main.go`
`views/` does not currently exist but as the project grows and I experiment more, view page templ views will be stored here
## Libraries & Tools