zishuo/onepanel
1
0
Fork 0
mirror of https://github.com/onepanelio/onepanel.git synced 2024-08-21 00:00:34 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: updated contributing guide to include docker version

Browse Source
This commit is contained in:
Andrey Melnikov 2020-12-17 22:49:16 -08:00
parent bd2d98c146
commit 779cba97c9
1 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md
View File

@ -1,5 +1,18 @@
## Database migrations
### Docker
Note: Up migrations are automatically executed when the application is run.
```bash
docker run --rm --mount type=bind,source="${PWD}",target=/root onepanel-helper:v1.0.0 goose -dir db/sql create <name> sql # Create migration in db/sql folder
docker run --rm --mount type=bind,source="${PWD}",target=/root onepanel-helper:v1.0.0 goose -dir db postgres "${DB_DATASOURCE_NAME}" up # Migrate the DB to the most recent version available
docker run --rm --mount type=bind,source="${PWD}",target=/root onepanel-helper:v1.0.0 goose -dir db postgres "${DB_DATASOURCE_NAME}" down # Roll back the version by 1
docker run --rm --mount type=bind,source="${PWD}",target=/root onepanel-helper:v1.0.0 goose help # See all available commands
```
### Local
Install `goose`:
```bash
go get -u github.com/pressly/goose/cmd/goose
@ -8,13 +21,15 @@ go get -u github.com/pressly/goose/cmd/goose
Note: Up migrations are automatically executed when the application is run.
```bash
goose -dir db create <name> sql # Create migration in db folder
goose -dir db/sql create <name> sql # Create migration in db/sql folder
goose -dir db postgres "${DB_DATASOURCE_NAME}" up # Migrate the DB to the most recent version available
goose -dir db postgres "${DB_DATASOURCE_NAME}" down # Roll back the version by 1
goose help # See all available commands
```
## gRPC installation
## gRPC
### local installation
Install gRPC:
```bash
@ -47,6 +62,15 @@ Make sure that your `$GOBIN` is in your `$PATH`.
## API code generation
### Docker
Generate Go and Swagger APIs:
```bash
docker run --rm --mount type=bind,source="${PWD}",target=/root onepanel-helper:v1.0.0 make api version=1.0.0
```
### Local Installation
Generate Go and Swagger APIs:
```bash
make api version=1.0.0