mirror/wakapi
1
0
Fork 0
mirror of https://github.com/muety/wakapi.git synced 2023-08-10 21:12:56 +03:00
Code Issues Projects Releases Wiki Activity

Update Readme.

Browse Source
This commit is contained in:
Ferdinand Mütsch 2020-03-31 11:25:24 +02:00
parent 0e61870568
commit b858a02ecd
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -16,8 +16,8 @@
## Usage ## Usage
* Create an empty MySQL database * Create an empty MySQL database
* Enable Go module support: `export GO111MODULE=on` * Enable Go module support: `export GO111MODULE=on`
* Get code: `go get github.com/n1try/wakapi` * Get code: `go get github.com/muety/wakapi`
* Go to project root: `cd "$GOPATH/src/github.com/n1try/wakapi"` * Go to project root: `cd "$GOPATH/src/github.com/muety/wakapi"`
* Copy `.env.example` to `.env` and set database credentials * Copy `.env.example` to `.env` and set database credentials
* Set target port in `config.ini` * Set target port in `config.ini`
* Build executable: `go build` * Build executable: `go build`
@ -27,7 +27,7 @@
* `api_key = the_api_key_printed_to_the_console_after_starting_the_server` * `api_key = the_api_key_printed_to_the_console_after_starting_the_server`
* Open [http://localhost:3000](http://localhost:3000) in your browser * Open [http://localhost:3000](http://localhost:3000) in your browser
**As an alternative** to building from source or using `go get` you can also download one of the existing [pre-compiled binaries](https://github.com/n1try/wakapi/releases). **As an alternative** to building from source or using `go get` you can also download one of the existing [pre-compiled binaries](https://github.com/muety/wakapi/releases).
### Run with Docker ### Run with Docker
* Edit `docker-compose.yml` file and change passwords for the DB * Edit `docker-compose.yml` file and change passwords for the DB