-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a getting started section to the readme
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,27 @@ | ||
# Go Web Template | ||
|
||
## Getting started | ||
|
||
How to get started with the scaffolding: | ||
|
||
1. Clone this repository | ||
``` | ||
go install golang.org/x/tools/cmd/gonew@latest | ||
gonew github.com/blackskad/go-web-scaffold github.com/$ACCOUNT/$PROJECTNAME | ||
``` | ||
|
||
1. Replace all mentions of go-web-scaffold with your own project name. At the moment, that's in the Dockerfile and in the GitHub build workflow. | ||
``` | ||
sed -i 's/blackskad\/go-web-scaffold/$ACCOUNT\/$PROJECTNAME/g' . | ||
``` | ||
|
||
1. Initialize the git repo and push them to your own GitHub repo. | ||
``` | ||
git init | ||
git remote add origin [email protected]:$ACCOUNT/$PROJECTNAME | ||
git push origin main | ||
``` | ||
|
||
## What's included | ||
|
||
### Basic setup | ||
|