diff --git a/docs/docs/developer/setup.md b/docs/docs/developer/setup.md index e813fa8f15..6b1177fbc9 100644 --- a/docs/docs/developer/setup.md +++ b/docs/docs/developer/setup.md @@ -16,7 +16,7 @@ Thanks for being interested in contributing 😊 ## Environment -### Server and web app +### Services This environment includes the services below. Additional details are available in each service's README. @@ -28,7 +28,7 @@ This environment includes the services below. Additional details are available i All the services are packaged to run as with single Docker Compose command. -### Instructions +### Server and web apps 1. Clone the project repo. 2. Run `cp docker/example.env docker/.env`. @@ -47,13 +47,7 @@ You can access the web from `http://your-machine-ip:2283` or `http://localhost:2 **Note:** the "web" development container runs with uid 1000. If that uid does not have read/write permissions on the mounted volumes, you may encounter errors -### Mobile app - -The mobile app `(/mobile)` will required Flutter toolchain 3.13.x to be installed on your system. - -Please refer to the [Flutter's official documentation](https://flutter.dev/docs/get-started/install) for more information on setting up the toolchain on your machine. - -### Connect to a remote backend +#### Connect web to a remote backend If you only want to do web development connected to an existing, remote backend, follow these steps: @@ -66,6 +60,14 @@ If you only want to do web development connected to an existing, remote backend, IMMICH_SERVER_URL=https://demo.immich.app/ npm run dev ``` +### Mobile app + +The mobile app `(/mobile)` will required Flutter toolchain 3.13.x to be installed on your system. + +Please refer to the [Flutter's official documentation](https://flutter.dev/docs/get-started/install) for more information on setting up the toolchain on your machine. + +The mobile app asks you what backend to connect to. You can utilize the demo backend (https://demo.immich.app/) if you don't need to change server code or can run the server yourself per the instructions above. + ## IDE setup ### Lint / format extensions