c-l/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-01-17 01:06:46 +01:00
Code Releases Activity

docs: clarify details of connecting to backend for development (#8727)

Browse source 
* docs: clarify details of connecting to backend for development

* simplify
This commit is contained in:
Ben McCann 2024-04-11 09:12:14 -07:00 committed by GitHub
parent a4267ed60f
commit 0d062b32a8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/docs/developer/setup.md
View file

@ -16,7 +16,7 @@ Thanks for being interested in contributing 😊
## Environment ## Environment
### Server and web app ### Services
This environment includes the services below. Additional details are available in each service's README. 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. All the services are packaged to run as with single Docker Compose command.
### Instructions ### Server and web apps
1. Clone the project repo. 1. Clone the project repo.
2. Run `cp docker/example.env docker/.env`. 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 **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 #### Connect web to a remote backend
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
If you only want to do web development connected to an existing, remote backend, follow these steps: 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 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 ## IDE setup
### Lint / format extensions ### Lint / format extensions