Skip to content

Commit

Permalink
Fix imports and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MightyMoud committed Sep 15, 2024
1 parent 5367e9d commit c92ace0
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 13 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Bare metal to production ready in mins; imagine fly.io on your VPS
<img width="500px" src="/demo/imgs/hero.png">
</div>

![GitHub](https://img.shields.io/github/license/ms-mousa/sidekick)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/ms-mousa/sidekick)
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/ms-mousa/sidekick)
![GitHub](https://img.shields.io/github/license/mightymoud/sidekick)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/mightymoud/sidekick)
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/mightymoud/sidekick)

</div>

Expand Down Expand Up @@ -46,13 +46,17 @@ Just make sure the following is true:

That's it!
### VPS Setup

<div align="center" >
<img width="500px" src="/demo/imgs/init.png">
</div>


First you need to setup your VPS. To do this you need to run:
```bash
sidekick init
```

Then you need to enter the following:
- IP Address of your VPS
- An email address to use for setting up SSL certs
Expand All @@ -61,6 +65,7 @@ Then you need to enter the following:
- Confirm you are currently logged in to that said registery with the username - This is needed to be able to push images on your behalf

After that Sidekick will setup many things on your VPS - Usually takes around 2 mins

<details>
<summary>What does Sidekick do when I run this command</summary>

Expand Down
2 changes: 1 addition & 1 deletion cmd/deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
"strconv"
"strings"

"github.com/ms-mousa/sidekick/utils"
"github.com/mightymoud/sidekick/utils"
"github.com/pterm/pterm"
"github.com/spf13/cobra"
"github.com/spf13/viper"
Expand Down
2 changes: 1 addition & 1 deletion cmd/env.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
"os/exec"
"strings"

"github.com/ms-mousa/sidekick/utils"
"github.com/mightymoud/sidekick/utils"
"github.com/pterm/pterm"
"github.com/spf13/cobra"
"github.com/spf13/viper"
Expand Down
4 changes: 2 additions & 2 deletions cmd/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ import (
"os/exec"
"strings"

"github.com/ms-mousa/sidekick/render"
"github.com/ms-mousa/sidekick/utils"
"github.com/mightymoud/sidekick/render"
"github.com/mightymoud/sidekick/utils"
"github.com/pterm/pterm"
"github.com/spf13/cobra"
"github.com/spf13/viper"
Expand Down
2 changes: 1 addition & 1 deletion cmd/launch.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
"strings"
"time"

"github.com/ms-mousa/sidekick/utils"
"github.com/mightymoud/sidekick/utils"
"github.com/pterm/pterm"
"github.com/spf13/cobra"
"github.com/spf13/viper"
Expand Down
2 changes: 1 addition & 1 deletion cmd/preview.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
"os/exec"
"strings"

"github.com/ms-mousa/sidekick/utils"
"github.com/mightymoud/sidekick/utils"
"github.com/pterm/pterm"
"github.com/spf13/cobra"
"github.com/spf13/viper"
Expand Down
2 changes: 0 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZ
github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
github.com/ms-mousa/sidekick v0.5.0 h1:DZc4H8+73IjS3dDnVQPZeI07sIJhSapy/1m7Wr6jO7w=
github.com/ms-mousa/sidekick v0.5.0/go.mod h1:gV6x7Rm1k3EiMQMdxxlnzj+NoHUAVBlNHvpjgywxckI=
github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM=
github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ limitations under the License.
*/
package main

import "github.com/ms-mousa/sidekick/cmd"
import "github.com/mightymoud/sidekick/cmd"

func main() {
cmd.Execute()
Expand Down
2 changes: 1 addition & 1 deletion utils/stages.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func GetTraefikStage(email string) CommandsStage {
SpinnerFailMessage: "Something went wrong setting up Traefik on your VPS",
Commands: []string{
"sudo apt-get install git -y",
"git clone https://github.com/ms-mousa/sidekick-traefik.git",
"git clone https://github.com/mightymoud/sidekick-traefik.git",
fmt.Sprintf(`cd sidekick-traefik/traefik && sed -i.bak 's/\$EMAIL/%s/g' traefik.yml && rm traefik.yml.bak`, email),
"sudo docker network create sidekick",
"cd sidekick-traefik && sudo docker compose -p sidekick -f docker-compose.traefik.yml up -d",
Expand Down

0 comments on commit c92ace0

Please sign in to comment.