Cutlery/immich
1
0
Fork 1
mirror of https://github.com/immich-app/immich.git synced 2025-11-03 19:17:11 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update contribution-guidelines.md (#985)

Browse Source
This commit is contained in:
Brandon Rothweiler 2022-11-17 00:30:58 -05:00 committed by GitHub
parent 7de7619fd1
commit 83e2cabbcc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/contribution-guidelines.md
View File

@ -20,12 +20,19 @@ This environment includes the following services:
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.
After cloning the project, from the root directory run ### Instructions
1. Clone the project repo.
2. Run `cp docker/.env.example docker/.env`.
3. Edit `docker/.env` to provide values for the required variables `UPLOAD_LOCATION` and `JWT_SECRET`.
4. From the root directory, run:
```bash title="Start development server" ```bash title="Start development server"
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.
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`