diff --git a/docs/docs/developer/setup.md b/docs/docs/developer/setup.md index dc61c37d42..d553ca7d8d 100644 --- a/docs/docs/developer/setup.md +++ b/docs/docs/developer/setup.md @@ -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 diff --git a/server/README.md b/server/README.md new file mode 100644 index 0000000000..61b6c25381 --- /dev/null +++ b/server/README.md @@ -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. diff --git a/web/README.md b/web/README.md new file mode 100644 index 0000000000..e9693ceb01 --- /dev/null +++ b/web/README.md @@ -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).