Update README.md and gitignore
This commit is contained in:
parent
e9bca62098
commit
75e09c05cf
|
@ -1,6 +1,2 @@
|
||||||
/backend/.env
|
/backend/.env
|
||||||
/backend/debug/
|
/backend/debug/
|
||||||
|
|
||||||
# generated files:
|
|
||||||
/backend/generated
|
|
||||||
/frontend/src/generated
|
|
||||||
|
|
73
README.md
73
README.md
|
@ -11,42 +11,9 @@ It is currently in early development.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
### Code generation
|
### Dependencies
|
||||||
|
|
||||||
To generate protobuf code and GRPC stubs, first install [protoc](https://grpc.io/docs/protoc-installation/) and the GRPC dependencies:
|
It is required that an [ffmpeg](https://ffmpeg.org/download.html) binary is available in the current path.
|
||||||
|
|
||||||
```
|
|
||||||
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
|
|
||||||
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
|
|
||||||
```
|
|
||||||
|
|
||||||
Then generate the code with:
|
|
||||||
|
|
||||||
```
|
|
||||||
./protogen.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
To generate the database access layer, first install [sqlc](https://sqlc.dev/).
|
|
||||||
|
|
||||||
```
|
|
||||||
cd backend/
|
|
||||||
sqlc generate
|
|
||||||
```
|
|
||||||
|
|
||||||
### Migrations
|
|
||||||
|
|
||||||
Database migrations require `golang-migrate`.
|
|
||||||
|
|
||||||
```
|
|
||||||
go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest
|
|
||||||
```
|
|
||||||
|
|
||||||
Migrations then can be run with:
|
|
||||||
|
|
||||||
```
|
|
||||||
cd backend/
|
|
||||||
migrate -path sql/migrations -database $DATABASE_URL up
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running the app
|
### Running the app
|
||||||
|
|
||||||
|
@ -65,3 +32,39 @@ The frontend can be launched on localhost:3000 with:
|
||||||
cd frontend/
|
cd frontend/
|
||||||
yarn start
|
yarn start
|
||||||
```
|
```
|
||||||
|
### Code generation
|
||||||
|
|
||||||
|
To regenerate protobuf code and GRPC stubs, first install [protoc](https://grpc.io/docs/protoc-installation/) and the GRPC dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
|
||||||
|
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Then generate the code with:
|
||||||
|
|
||||||
|
```
|
||||||
|
./protogen.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
To regenerate the database access layer, first install [sqlc](https://sqlc.dev/). New queries can be added to `backend/sql/queries.sql`, and code regenerated with:
|
||||||
|
|
||||||
|
```
|
||||||
|
cd backend/
|
||||||
|
sqlc generate
|
||||||
|
```
|
||||||
|
|
||||||
|
### Migrations
|
||||||
|
|
||||||
|
Database migrations require [golang-migrate](https://github.com/golang-migrate/migrate).
|
||||||
|
|
||||||
|
```
|
||||||
|
go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Migrations then can be run with:
|
||||||
|
|
||||||
|
```
|
||||||
|
cd backend/
|
||||||
|
migrate -path sql/migrations -database $DATABASE_URL up
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue