-
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.
- Loading branch information
1 parent
bde5b67
commit 380db0a
Showing
2 changed files
with
40 additions
and
41 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: Getting Started | ||
index: 2 | ||
--- | ||
|
||
The only requirement to get started with Leapkit is to have Go installed on your machine. You can download Go from [here](https://golang.org/dl/). Make sure you install the latest version of Go. | ||
Once you have installed Go, you can proceed to generate your first projects | ||
|
||
``` | ||
go run go.leapkit.com/tools/new@latest [project_name] | ||
``` | ||
|
||
### Setup | ||
Once the project is generated you can setup the project by running the following command: | ||
|
||
``` | ||
go mod download | ||
``` | ||
|
||
This will install the necessary dependencies and setup the project for development. | ||
|
||
### Running the application | ||
|
||
Running the application will depend on the version of Go you have intalled for Go 1.23 you can run: | ||
|
||
```go | ||
go run go.leapkit.com/tools/dev@latest | ||
``` | ||
|
||
If you're using Go 1.24 you can set that as a tool in your `go.mod` file: | ||
|
||
```go | ||
// This will be needed once. | ||
go get -tool go.leapkit.com/tools/dev | ||
|
||
// Then every time you need to run the application | ||
go tool dev | ||
``` | ||
|
||
Once the application is running it should be [accessible locally](http://localhost:3000). |