new_gotham

command module
v0.0.0-...-72674db Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 30, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

README

GOTHAM Stack Starter App

welcome to the most basic app to get you started with the amazing SSR webstack (GOTHAM). more in depth examples (session, routing, todo app) found here.

Prerequisites

Ensure the following dependencies are installed before setting up and running the app:

  • If you are on MacOS and have homebrew installed, simply run:
# macOS users with Homebrew
brew install go git mariadb node
  • For linux or windows users kindly follow official instructions:

Tailwindcss and Templ

# Bun
curl -fsSL https://bun.sh/install | bash

# Tailwind CSS using Bun
bun install -g tailwindcss@latest

# Templ
go install github.com/a-h/templ/cmd/templ@latest

Usage

  • clone this repo:
git clone https://github.com/morethancoder/new_gotham 
  • make sure your mariadb server is running.
  • create a .env file inside the project directory, and fill database credentials:
cd new_project && mv dotenv .env
  • make it yours, edit go.mod module name (optional):
go mod edit -module="your project name"
  • tidy project go dependencies:
go mod tidy
  • templ:
make templ
  • test:
make test
  • run:
make run
  • enjoy the best SSR web stack

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL