Skip to content

Commit

Permalink
Add redis section to dev guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dmohns committed Dec 11, 2024
1 parent ac39399 commit d74e0f5
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/development/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,30 @@ This can be helpful if

## Advanced development environment

The above instructions describe how to set up a simple local environment of MPM.
The above instructions describe how to set up a simple local environment of MicroPowerManager.
This is great for exploring the project both by interacting with the app and potentially some smaller code changes.

However, if you are considering to **contribute to MicroPowerManager** code base it is recommended to set up some additional steps and tools for developer's convienience.

We describe an example set up that has proven to work well based on [VS Code](https://code.visualstudio.com/).
Configurations for a different editor will work a like.

### Local PHP installation

For local development and editor integration it can be helpful to have a local instance of PHP.
This will allow you to run composer scripts like `phpstan-analyse` without the need to use Docker.

These steps are highly dependant on your system.

For example using `brew` on MacOS

```sh
brew install php@8.2
pecl install redis
```

Alternatively [Laravel Herd](https://herd.laravel.com/) can be used.

### Linter configuration

The project uses various linters to ensure a consitent code base across the project.
Expand Down

0 comments on commit d74e0f5

Please sign in to comment.