diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 94b6dfd..4ee4631 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -43,12 +43,14 @@ Please ask as many questions as you need, either directly in the issue or on [Di ### Project Setup for Authorizer core 1. Fork the [authorizer](https://github.com/authorizerdev/authorizer) repository (**Skip this step if you have access to repo**) -2. `git clone https://github.com/authorizerdev/authorizer.git` -3. `cd authorizer` -4. `cp .env.sample .env`. Check all the supported env [here](https://docs.authorizer.dev/core/env/) -5. Build the code `make clean && make` +2. Clone repo: `git clone https://github.com/authorizerdev/authorizer.git` or use the forked url from step 1 +3. Change directory to authorizer: `cd authorizer` +5. Create Env file `cp .env.sample .env`. Check all the supported env [here](https://docs.authorizer.dev/core/env/) +6. Build Dashboard `make build-dashboard` +7. Build App `make build-app` +8. Build Server `make clean && make` > Note: if you don't have [`make`](https://www.ibm.com/docs/en/aix/7.2?topic=concepts-make-command), you can `cd` into `server` dir and build using the `go build` command -6. Run binary `./build/server` +9. Run binary `./build/server` ### Testing diff --git a/README.md b/README.md index 98095bb..f8beb5b 100644 --- a/README.md +++ b/README.md @@ -78,12 +78,14 @@ This guide helps you practice using Authorizer to evaluate it before you use it ### Project Setup 1. Fork the [authorizer](https://github.com/authorizerdev/authorizer) repository (**Skip this step if you have access to repo**) -2. `git clone https://github.com/authorizerdev/authorizer.git` -3. `cd authorizer` -4. `cp .env.sample .env`. Check all the supported env [here](https://docs.authorizer.dev/core/env/) -5. Build the code `make clean && make` +2. Clone repo: `git clone https://github.com/authorizerdev/authorizer.git` or use the forked url from step 1 +3. Change directory to authorizer: `cd authorizer` +5. Create Env file `cp .env.sample .env`. Check all the supported env [here](https://docs.authorizer.dev/core/env/) +6. Build Dashboard `make build-dashboard` +7. Build App `make build-app` +8. Build Server `make clean && make` > Note: if you don't have [`make`](https://www.ibm.com/docs/en/aix/7.2?topic=concepts-make-command), you can `cd` into `server` dir and build using the `go build` command -6. Run binary `./build/server` +9. Run binary `./build/server` ## Install using binaries