Skip to content

Commit

Permalink
update readme -2
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukmanern committed Feb 1, 2024
1 parent 6b1bb76 commit f62fa79
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Golang project starter with Fiber Framework, jwt-auth, email service and soft de

 

## :rocket: Technologies And :wrench: Tools
## :rocket: Technologies and :wrench: Tools

Techs and tools were used in this project:

Expand All @@ -21,7 +21,7 @@ Techs and tools were used in this project:

 

## Run Project
## :checkered_flag: Run Project

1. Clone project

Expand All @@ -31,17 +31,27 @@ git clone https://github.com/Lukmanern/gost && cd gost

2. Rename or copy the file .env.example to .env

3. Fill all the values in the .env file. For a quick setup, I suggest using Supabase for the database and Gmail for the system email.
3. Fill all the values in the .env file. For a quick setup, I suggest using [Supabase](https://www.supabase.com) for the database and Gmail for the system email.

4. Download all dependencies, turn on Redis, and then test the connections to the databases (DB and Redis).

```bash
go get -v ./... && go test ./database/...
```

## Github Action and Repository
5. Run the project and try to hit hello endpoints : /hello and /hello/your-name

1. Remove the .git directory to prevent repository cloning.
```bash
go run .
```

6. Last but not least, if you are using VSCode, you can easily search/find and replace github.com/Lukmanern/gost with your repository.

 

## :octocat: Github Action and Repository

1. Delete the .git directory to prevent repository cloning.

2. Create a repository on GitHub, but don't push initially. Ensure to add the Repository Secrets for GitHub Actions (SNYK_TOKEN and ENV).

Expand All @@ -55,7 +65,7 @@ go get -v ./... && go test ./database/...

 

## Some Tips
## :dango: Some Tips

1. You can use [Github-CLI](https://cli.github.com/) to set, remove, or update your GitHub Repository Secret.

Expand Down

0 comments on commit f62fa79

Please sign in to comment.