Add readme for top level folder, clean up dead code

This commit is contained in:
Alex Tran
2022-02-03 15:27:31 -06:00
parent 85b83f9666
commit 613b4449a7
7 changed files with 90 additions and 60 deletions

33
README.md Normal file
View 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
```