self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-26 10:50:29 +02:00
Code Issues Releases Activity

doc: developer setup docs (#6557)

Browse Source
This commit is contained in:
Aram Akhavan 2024-01-21 14:32:01 -08:00 committed by GitHub
parent b34a808fbb
commit 6b419a984c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/developer/setup.md
View File

@ -35,18 +35,22 @@ All the services are packaged to run as with single Docker Compose command.
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`.
3. Edit `docker/.env` to provide values for the required variable `UPLOAD_LOCATION`. 3. Edit `docker/.env` to provide values for the required variable `UPLOAD_LOCATION`.
4. From the root directory, run: 4. Install the required dependencies (nodejs >20, a modern java version e.g. OpenJDK 17)
5. From the root directory, run:
```bash title="Start development server" ```bash title="Start development server"
make open-api # this is the only step that requires the above dependencies
make dev # required Makefile installed on the system. make dev # required Makefile installed on the system.
``` ```
5. Access the dev instance in your browser at http://localhost:2283, or connect via the mobile app. 6. Access the dev instance in your browser at http://localhost:2283, or connect via the mobile app.
All the services will be started with hot-reloading enabled for a quick feedback loop. All the services will be started with hot-reloading enabled for a quick feedback loop.
You can access the web from `http://your-machine-ip:2283` or `http://localhost:2283` and access the server from the mobile app at `http://your-machine-ip:2283/api` You can access the web from `http://your-machine-ip:2283` or `http://localhost:2283` and access the server from the mobile app at `http://your-machine-ip:2283/api`
**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 ### Mobile app
The mobile app `(/mobile)` will required Flutter toolchain 3.13.x to be installed on your system. The mobile app `(/mobile)` will required Flutter toolchain 3.13.x to be installed on your system.