Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander-D-Karpov committed Jul 16, 2024
1 parent 7fab423 commit 14d686e
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,32 @@ This project is a webring relay service built with Go. It manages a list of webs
- PostgreSQL database

## Installation

edit .env to set correct path to database

```
go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest
go mod tidy
cp .env.template .env
make migrate-up
```

## Local Run

```
go run cmd/server/main.go
```

or download prebuild version

```
wget https://github.com/Alexander-D-Karpov/webring/releases/latest/download/webring
chmod +x webring
./webring
```



## Usage

- Access the dashboard at `http://localhost:8080/dashboard` (use the credentials set in your `.env` file)
Expand Down

0 comments on commit 14d686e

Please sign in to comment.