mirror of
https://github.com/KevinMidboe/immich.git
synced 2025-10-29 17:40:28 +00:00
Add readme for top level folder, clean up dead code
This commit is contained in:
33
README.md
Normal file
33
README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# IMMICH
|
||||
|
||||
Self-hosted Photo backup solution directly from your mobile phone.
|
||||
|
||||
# Development
|
||||
|
||||
You can use docker compose for development, there are several services that compose Immich
|
||||
|
||||
1. The server
|
||||
2. PostgreSQL
|
||||
3. Redis
|
||||
|
||||
## Populate .env file
|
||||
|
||||
Navigate to `server` directory and run
|
||||
|
||||
```
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
Then populate the value in there.
|
||||
|
||||
To start, run
|
||||
|
||||
```bash
|
||||
docker-compose up ./server
|
||||
```
|
||||
|
||||
To force rebuild node modules after installing new packages
|
||||
|
||||
```bash
|
||||
docker-compose up --build -V ./server
|
||||
```
|
||||
Reference in New Issue
Block a user