Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: contribute #1234

Merged
merged 2 commits into from
Mar 19, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,25 @@ This page describe the project structure and gives you a bit of context to start

**Requirements :**

- Node.js >= v10.x
- Nodejs >= v15
- npm or yarn
- Go >= 1.16
- [swag](https://github.com/swaggo/swag)

**Note:** if you're using npm, just replace `yarn <command>` by `npm run <command>`.

```shell
# Install tools needed to build, creating mocks or running tests
$ make install-tools

# Build static assets
# This will create dist directory containing client's static files
$ (cd web/client && yarn && yarn build)

# Generate in-memory assets
# This will put content of dist directory in memory. It's usually needed to build but
# the design requires you to do it anyway.
# Generate in-memory assets, then build the project.
# This will put content of dist directory in a single binary file.
# It's needed to build but the design requires you to do it anyway.
# This step is needed at each change if you're developing on the client.
$ go generate ./...

# Build the whole project
$ go build -v .
$ make build
```

If you're developing, you don't need to build at each changes, you can compile then run with the `go run` command :
Expand Down