Skip to content

Commit

Permalink
update DEVELOPMENT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
floreks committed Mar 6, 2024
1 parent adfbe16 commit 9b2fc53
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ When writing new Go code, we try to follow conventions described in [Effective G

For Angular, we try to follow conventions described in [Angular Style Guide](https://angular.io/guide/styleguide) and [Material Design Guidelines](https://material.io/guidelines/).

We are running a set of checks for each pull request, all of them have to be successful before the change can be merged. You can run most of them locally using `make` targets, i.e. `make test` or `make check` (see [`Makefile`](Makefile) for more information).
We are running a set of checks for each pull request, all of them have to be successful before the change can be merged. You can run most of them locally using `make` targets, i.e. `make test` or `make check` (see [Makefile](Makefile) for more information).

Tools that we are using include [golangci-lint](https://github.com/golangci/golangci-lint), [eslint](https://eslint.org), [stylelint](https://github.com/stylelint/stylelint), [prettier](https://prettier.io/).

Expand All @@ -28,21 +28,31 @@ Tools that we are using include [golangci-lint](https://github.com/golangci/gola
Make sure the following software is installed and added to your path:

- [Docker](https://docs.docker.com/engine/install/)
- [Go](https://golang.org/dl/) (check the required version in [`modules/go.work`](modules/go.work))
- [Node.js](https://nodejs.org/en/download) (check the required version in [`modules/web/package.json`](modules/web/package.json))
- [Yarn](https://yarnpkg.com/getting-started/install) (check the required version in [`modules/web/.yarnrc.yml`](modules/web/.yarnrc.yml))
- [Go](https://golang.org/dl/) (check the required version in [modules/go.work](modules/go.work))
- [Node.js](https://nodejs.org/en/download) (check the required version in [modules/web/package.json](modules/web/package.json))
- [Yarn](https://yarnpkg.com/getting-started/install) (check the required version in [modules/web/.yarnrc.yml](modules/web/.yarnrc.yml))

## Getting Started

After cloning the repository, install web dependencies with `cd modules/web && yarn`.

Then you can start the development version of the application with `make serve` It will create local kind cluster and run all the modules with Docker compose.

If you would like to run production version use `make run`
If you would like to run production version of the application use `make run`.

To run a full end-to-end test use `make helm`. It will:
- spin up a local kind dev cluster and expose 443 port (make sure that this port is free on your host)
- install ingress-nginx for kind
- update local helm dependencies
- build all production ready docker images
- load built images into the kind dev cluster
- install Kubernetes Dashboard via helm chart inside kind dev cluster

Kubernetes Dashboard should be then available directly on your localhost: https://localhost

To create Docker images locally use `make image`.

See [`Makefile`](Makefile) to get to know other targets useful during development. You can also run `make help` to quickly check the list of available commands.
See [Makefile](Makefile) to get to know other targets useful during development. You can also run `make help` to quickly check the list of available commands.

## Dependency Management

Expand Down

0 comments on commit 9b2fc53

Please sign in to comment.