README
¶
Your awesome project
Welcome to the yet another awesome project generated with the Gowebly CLI! 🎉
This README file contains all the necessary information about:
- Project overview
- Folders structure
- Starting your project
- Developing your project
- Deploying your project
And some words about the Gowebly CLI.
Project overview
Backend:
- Module name in the go.mod file:
github.com/ArkLabsHQ/fulmine - Go web framework/router:
gin - Server port:
7000
Frontend:
- Package name in the package.json file:
frontend - Reactivity library:
htmx - CSS framework:
tailwindcss
Tools:
- Air tool to live-reloading: ✓
- Bun as a frontend runtime: ✕
- Templ to generate HTML: ✓
- Config for golangci-lint: ✓
Folders structure
.
├── assets
│ ├── scripts.js
│ └── styles.scss
├── static
│ ├── images
│ │ └── gowebly.svg
│ ├── apple-touch-icon.png
│ ├── favicon.ico
│ ├── favicon.png
│ ├── favicon.svg
│ ├── manifest-desktop-screenshot.jpeg
│ ├── manifest-mobile-screenshot.jpeg
│ ├── manifest-touch-icon.svg
│ └── manifest.webmanifest
├── templates
│ ├── pages
│ │ └── index.templ
│ └── main.templ
├── .gitignore
├── .dockerignore
├── .prettierignore
├── .air.toml
├── Dockerfile
├── docker-compose.yml
├── prettier.config.js
├── package.json├── golangci.yml
├── go.mod
├── go.sum
├── handlers.go
├── server.go
├── main.go
└── README.md
Starting your project
To start your project, run the Gowebly CLI command in your terminal:
gowebly run
Developing your project
The backend part is located in the *.go files in your project folder.
The ./templates folder contains Templ templates that you can use in your frontend part. Also, the ./assets folder contains the styles.scss (main styles) and scripts.js (main scripts) files.
The ./static folder contains all the static files: icons, images, PWA (Progressive Web App) manifest and other builded/minified assets.
Deploying your project
All deploy settings are located in the Dockerfile and docker-compose.yml files in your project folder.
To deploy your project to a remote server, follow these steps:
- Go to your hosting/cloud provider and create a new VDS/VPS.
- Update all OS packages on the server and install Docker, Docker Compose and Git packages.
- Use
git clonecommand to clone the repository with your project to the server and navigate to its folder. - Run the
docker-compose upcommand to start your project on your server.> ❗️ Don't forget to generate Go files from*.templtemplates before run thedocker-compose upcommand.
About the Gowebly CLI
The Gowebly CLI is a next-generation CLI tool that makes it easy to create amazing web applications with Go on the backend, using htmx, hyperscript or Alpine.js, and the most popular CSS frameworks on the frontend.
It's highly recommended to start exploring the Gowebly CLI with short articles "What is Gowebly CLI?" and "How does it work?" to understand the basic principle and the main components built into the Gowebly CLI.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewService ¶
func NewService( appSvc *application.Service, stopCh chan struct{}, sentryEnabled bool, arkServer string, ) *service
func RemoveFind ¶ added in v0.1.12
RemoveFind drops the first element in slice for which match(v) is true. It returns the updated slice, the removed element, and true. If nothing matches, it returns the original slice, the zero value, and false.
Types ¶
type TemplRender ¶
TemplRender implements the render.Render interface.
func (*TemplRender) Instance ¶
func (t *TemplRender) Instance(name string, data interface{}) render.Render
Instance implements the render.Render interface.
func (TemplRender) Render ¶
func (t TemplRender) Render(w http.ResponseWriter) error
Render implements the render.Render interface.
func (TemplRender) WriteContentType ¶
func (t TemplRender) WriteContentType(w http.ResponseWriter)
WriteContentType implements the render.Render interface.
Source Files
Directories