From 98038e14514812818f74975354764b5dc8e2f076 Mon Sep 17 00:00:00 2001 From: Antonio De Lucreziis Date: Wed, 3 May 2023 21:25:50 +0200 Subject: [PATCH] chore: updated readme --- README.md | 33 +++++---------------------------- 1 file changed, 5 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index d57aa8c..8eabdd0 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,16 @@ -# Go Vite Kit +# Cluster Dashboard -Minimal boilerplate project for a Golang server using [Fiber](https://github.com/gofiber/fiber) and [ViteJS](https://github.com/vitejs/vite) for static pages +Una dashboard web moderna per il cluster "steffe" per il progetto di calcolo parallelo del prof. Durastante. ## Features - ⚡️ [Go Fiber](https://github.com/gofiber/fiber) - 📦 [ViteJS](http://vitejs.dev/) - 🎨 [Sass](https://sass-lang.com/) -- 🗄️ [Sqlite3](https://github.com/mattn/go-sqlite3) ## Architecture -- `frontend/` - - This is a Vite project for building all the static pages used by this app. - -- `backend/` - - This keeps all server related files - - - `config/` - - Loads env variables and keeps them as globals - - - `database/` - - Module with a `Database` interface and two implementation: `memDB` is an in-memory database for testing purposes. `sqliteDB` is a wrapper for working with an SQLite database. - - - `routes/` - - Various functions for configuring all the server routes. - - A very important file is `backend/routes/router.go` that contains the `HtmlEntrypoints` variable that is used both by the backend and ViteJS to mount HTML entrypoints. - - When building the frontend ViteJS will call `go run ./meta/routes` to read the content of the `HtmlEntrypoints` variable. This is also used while developing to let Vite know add all necessary entrypoints to the dev server. +Questo progetto è stato generato dal template, alcune informazioni sull'architettura di questo progetto si trovano su ## Usage @@ -61,8 +38,8 @@ $ fd -e go | MODE=dev entr -r go run -v ./cmd/server You can build everything with the following command, it will build first the frontend and then the backend and generate `./out/server`. ```bash -# Build -$ go run -v ./cmd/build +$ npm run build +$ go build -o ./out/server ./cmd/server # Run $ ./out/server