Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a getting started section to the readme #19

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Add a getting started section to the readme #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
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