Skip to content

Commit

Permalink
task: tweaking more the get started doc
Browse files Browse the repository at this point in the history
  • Loading branch information
paganotoni committed Feb 23, 2025
1 parent 380db0a commit 64ab7a8
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,34 @@ 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

```
```sh
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:
Once the project is generated you can go into the project folder and run the following command:

```
```sh
go mod download
```

This will install the necessary dependencies and setup the project for development.
This will install the necessary dependencies.

### Running the application

Running the application will depend on the version of Go you have intalled for Go 1.23 you can run:

```go
```sh
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.
```sh
# This will be needed once.
go get -tool go.leapkit.com/tools/dev

// Then every time you need to run the application
# Then every time you want to run the application
go tool dev
```

Once the application is running it should be [accessible locally](http://localhost:3000).
This will read the Procfile in the root of the folder and start the processes defined in it. Once the application is running it should be [accessible locally](http://localhost:3000).

0 comments on commit 64ab7a8

Please sign in to comment.