AFFiNE/packages/frontend/electron/README.md

27 lines
615 B
Markdown
Raw Normal View History

2023-03-16 17:58:21 +03:00
# AFFiNE Electron App
## Development
2023-04-14 16:01:31 +03:00
To run AFFiNE Desktop Client Application locally, run the following commands:
2023-03-16 17:58:21 +03:00
2023-04-14 16:01:31 +03:00
```sh
# in repo root
yarn install
yarn workspace @affine/native build
yarn dev
2023-04-14 16:01:31 +03:00
# in packages/frontend/electron
2023-04-14 16:01:31 +03:00
yarn generate-assets
yarn dev # or yarn prod for production build
2023-03-16 17:58:21 +03:00
```
## Troubleshooting
2023-03-16 17:58:21 +03:00
## Credits
Most of the boilerplate code is generously borrowed from the following
- [vite-electron-builder](https://github.com/cawa-93/vite-electron-builder)
- [Turborepo basic example](https://github.com/vercel/turborepo/tree/main/examples/basic)
- [yerba](https://github.com/t3dotgg/yerba)