Skip to content

Latest commit

 

History

History
68 lines (58 loc) · 2.22 KB

README.md

File metadata and controls

68 lines (58 loc) · 2.22 KB
Raw

go-web-app

A cookiecutter for quickly scaffolding go web applications

This is a highly opinionated way of creating a Go web app. After manually creating these time and time again this is how I've settled on bootstrapping new app's.

The application uses Go templates but can also be just an API backend; go-chi is the router and is highly extensible.

Usage

To create a new go-chi web app using this repository you only need to run the following:

cookiecutter https://github.com/danielmichaels/go-web-app
# or gh:danielmichaels/go-web-app

And then answer the prompts. Here's an example run using the defaults:

z ❯ cookiecutter https://github.com/danielmichaels/go-web-app
github_username [danielmichaels]: 
project_name [go-web-app]: 
project_slug [go-web-app]: 
cmd_name [app]: 
project_description [A chi based web application capable of being driven by templates and APIs]: 
go_module_path [github.com/danielmichaels/go-web-app]: 
Select go_version:
1 - 1.18
2 - 1.19
3 - 1.20
Choose from 1, 2, 3 [3]:

This will create a directory called go-web-app in the current working directory. All upper case letters are converted to lowercase and hypens are used instead of spaces.

After cookiecutter has run the following output will be printed to the screen detailing what to do next.

====================================================================================
Your project `go-web-app` is ready!
The following is a *brief* overview of steps to push code to remote and
how to get your go module working.
- Move to project directory, and initialize a git repository:
    $ cd go-web-app && git init
- Run go mod tidy to pull in dependencies:
    $ go mod tidy
- If you want to update upstream dependencies (optional; recommended)
    $ go get -u
- Create node resources (Tailwind and Alpine.js)
    $ yarn
    $ make assets
- Check the code works (if you have `air` in your $PATH)
    $ air
    or:
    $ go run cmd/app/main.go
    or:
    $ make run/app
- Upload initial code to git:
    $ git add -a
    $ git commit -m "Initial commit!"
    $ git remote add origin https://github.com/danielmichaels/go-web-app.git
    $ git push -u origin --all