cotugno/immich
2
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-11-15 01:48:49 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: add some details for getting started as a developer (#8468)

Browse Source
This commit is contained in:
Ben McCann 2024-04-02 09:56:33 -07:00 committed by GitHub
parent f7afc0334e
commit 62d307321a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,12 +18,11 @@ Thanks for being interested in contributing 😊
### Server and web app
This environment includes the following services:
This environment includes the services below. Additional details are available in each service's README.
- Core server - `/server/src/immich`
- Machine learning - `/machine-learning`
- Microservices - `/server/src/microservicess`
- Web app - `/web`
- Server - [`/server`](https://github.com/immich-app/immich/tree/main/server)
- Web app - [`/web`](https://github.com/immich-app/immich/tree/main/web)
- Machine learning - [`/machine-learning`](https://github.com/immich-app/immich/tree/main/machine-learning)
- Redis
- PostgreSQL development database with exposed port `5432` so you can use any database client to acess it

3
server/README.md Normal file
View File

@ -0,0 +1,3 @@
# Immich server project
This project uses the [NestJS](https://nestjs.com/) web framework. Please refer to [the NestJS docs](https://docs.nestjs.com/) for information on getting started as a contributor to this project.

5
web/README.md Normal file
View File

@ -0,0 +1,5 @@
# Immich web project
This project uses the [SvelteKit](https://kit.svelte.dev/) web framework. Please refer to [the SvelteKit docs](https://kit.svelte.dev/docs) for information on getting started as a contributor to this project. In particular, it will help you navigate the project's code if you understand the basics of [SvelteKit routing](https://kit.svelte.dev/docs/routing).
When developing locally, you will run a SvelteKit Node.js server. When this project is deployed to production, it is built as a SPA and deployed as part of [../server](the server project).