Skip to content

Commit

Permalink
Merge pull request #19 from blackskad/readme-getting-started
Browse files Browse the repository at this point in the history
Add a getting started section to the readme
  • Loading branch information
blackskad authored Aug 28, 2024
2 parents 5e97361 + 639c488 commit 1890831
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
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
Expand Down

0 comments on commit 1890831

Please sign in to comment.