Add development notes

This commit is contained in:
Manav Rathi 2024-02-16 10:00:21 +05:30
parent 3720abe0ed
commit 703031f73c
2 changed files with 28 additions and 0 deletions

19
docs/Dev.md Normal file
View file

@ -0,0 +1,19 @@
## Monorepo
The monorepo uses Yarn (classic) workspaces.
To run a command for a workspace `<ws>`, invoke `yarn workspace <ws> <cmd>` from
the root folder instead the the `yarn <cmd>` youd have done otherwise.
To add a local package as a dependency, use `<package-name>@*`. The "*" here
denotes any version.
```sh
yarn workspace photos add '@/utils@*'
```
To see what packages depend on each other locally, use
```sh
yarn workspaces info
```

9
docs/README.md Normal file
View file

@ -0,0 +1,9 @@
## Notes for maintainers
If you just want to run ente locally or develop on it, you can do
yarn
yarn photos:dev
The notes in this directory are for maintainers to note down more advanced or
infrequently needed details.