Skip to content

Commit

Permalink
Update DEVELOP.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ericof committed Nov 16, 2023
1 parent b4cd204 commit eae6f62
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,36 @@ Then install the dependencies and a development instance using:
```bash
make build
```

### Start Local Server

Start Plone, on port 8080, with the command:

```bash
make start
```

#### Keycloak

The `pas.plugins.oidc` repository has a working setup for a `Keycloak` development server using `Docker` and `Docker Compose`. To use it, in a terminal, run the command:

```bash
make keycloak-start
```

There are two realms configured `plone` and `plone-test`. The later is used in automated tests, while the former should be used for your development environment.

The `plone` realm ships with an user that has the following credentials:

* username: **user**
* password: **12345678**

To stop a running `Keycloak` (needed when running tests), use:

```bash
make keycloak-stop
```

### Update translations

```bash
Expand Down Expand Up @@ -34,3 +64,9 @@ Run all tests but stop on the first error and open a `pdb` session:
```bash
./bin/tox -e test -- -x --pdb
```

Run tests named `TestServiceOIDCPost`:

```bash
./bin/tox -e test -- -k TestServiceOIDCPost
```

0 comments on commit eae6f62

Please sign in to comment.