aggiornato per uso di taiwind
This commit is contained in:
74
README.md
74
README.md
@@ -1,14 +1,34 @@
|
||||
# GoFiber MVC Boilerplate
|
||||
|
||||
Boilerplate GoFiber MVC + HTMX + Svelte Custom Elements + GORM, con auth server-rendered, area private/admin e mail sink in sviluppo.
|
||||
Boilerplate GoFiber MVC + HTMX + Flowbite + GORM, con auth server-rendered, area private/admin e mail sink in sviluppo.
|
||||
|
||||
## Setup Assets + Server
|
||||
|
||||
Terminale 1:
|
||||
|
||||
```bash
|
||||
npm i --prefix flowbite-ui
|
||||
make assets
|
||||
make tw-watch
|
||||
```
|
||||
|
||||
Terminale 2:
|
||||
|
||||
```bash
|
||||
make server
|
||||
```
|
||||
|
||||
`make assets` esegue:
|
||||
- copia di `flowbite-ui/node_modules/flowbite/dist/flowbite.min.js` in `web/static/vendor/flowbite.js`
|
||||
- build Tailwind in `web/static/css/app.css`
|
||||
|
||||
## Quickstart SQLite
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
make css-build
|
||||
make ui-build
|
||||
make dev
|
||||
npm i --prefix flowbite-ui
|
||||
make assets
|
||||
make server
|
||||
```
|
||||
|
||||
Default SQLite path: `./data/app.sqlite3`.
|
||||
@@ -37,32 +57,12 @@ DB_PG_DSN=postgres://trustcontact:trustcontact@localhost:5432/trustcontact?sslmo
|
||||
|
||||
`DB_POSTGRES_DSN` è comunque supportato.
|
||||
|
||||
## Tailwind + UI Kit
|
||||
|
||||
Tailwind (template server-rendered) compila in `web/static/css/app.css`.
|
||||
|
||||
UI kit (Svelte custom elements) compila in `web/static/ui`.
|
||||
|
||||
Comandi:
|
||||
|
||||
```bash
|
||||
make css-build # build tailwind
|
||||
make css-dev # watch tailwind
|
||||
make ui-build # build ui-kit + css tailwind
|
||||
make ui-dev # vite dev server ui-kit
|
||||
```
|
||||
|
||||
Layout include:
|
||||
|
||||
- `/static/css/app.css?v={{.BuildHash}}`
|
||||
- `/static/ui/ui.css?v={{.BuildHash}}`
|
||||
- `/static/ui/ui.esm.js?v={{.BuildHash}}`
|
||||
|
||||
## Template Directories
|
||||
|
||||
- Public: `web/templates/public`
|
||||
- Private: `web/templates/private`
|
||||
- Admin: `web/templates/admin`
|
||||
- Components Flowbite: `web/templates/components`
|
||||
|
||||
## Email in Develop
|
||||
|
||||
@@ -70,11 +70,25 @@ In `develop`, le email vengono salvate in `./data/emails`.
|
||||
|
||||
## Make Targets
|
||||
|
||||
- `make dev` -> `go run ./cmd/server`
|
||||
- `make ui-build` -> install + build ui-kit + build css tailwind
|
||||
- `make ui-dev` -> watch UI con Vite
|
||||
- `make css-build` -> build Tailwind CSS
|
||||
- `make css-dev` -> watch Tailwind CSS
|
||||
- `make tw-build` -> build Tailwind CSS
|
||||
- `make tw-watch` -> watch Tailwind CSS
|
||||
- `make flowbite-copy` -> copia `flowbite-ui/node_modules/flowbite/dist/flowbite.min.js` in `web/static/vendor/flowbite.js`
|
||||
- `make assets` -> `flowbite-copy` + `tw-build`
|
||||
- `make server` -> `go run ./cmd/server`
|
||||
- `make test` -> `go test ./...`
|
||||
- `make db-reset` -> reset DB sqlite locale (`./data/app.db` / `./data/app.sqlite3`)
|
||||
- `make fmt` -> `gofmt` su `cmd/` e `internal/`
|
||||
# Third-Party Notices
|
||||
|
||||
This project uses third-party software distributed under the MIT License.
|
||||
|
||||
## Flowbite
|
||||
- Package: `flowbite`
|
||||
- License: MIT
|
||||
- Upstream: https://github.com/themesberg/flowbite
|
||||
- Full text: `licenses/FLOWBITE-MIT.txt`
|
||||
|
||||
## Tailwind CSS
|
||||
- Packages: `tailwindcss`, `@tailwindcss/cli`
|
||||
- License: MIT
|
||||
- Upstream: https://github.com/tailwindlabs/tailwindcss
|
||||
|
||||
Reference in New Issue
Block a user