Files
flipper/desktop/flipper-server/README.md
Michel Weststrate 86b6d2c99d Make flipper-server NPX-able
Summary: Make sure flipper-server is bundled in such a way that it is self-contained NPX-able. Also added some checks to make sure that dev dependencies don't accidentallly end up in in Flipper buidls

Reviewed By: nikoant

Differential Revision: D33190254

fbshipit-source-id: 443162e537d8ca9f956acac2d7bd52cbf0c92172
2021-12-24 02:16:48 -08:00

41 lines
808 B
Markdown

# flipper-server (TBD)
Stand alone Flipper server as NodeJS process, that uses flipper-server-core for device communication and also provides a webserver to serve flipper-ui.
Flipper-server can be used as background process, for example on CI servers or to power IDE plugins.
## Running flipper server
### From NPM
TODO:
### From source
```
cd <Flipper checkout>/desktop
yarn install
yarn flipper-server
```
### Production build from source
```
cd <Flipper checkout>/desktop
yarn install
yarn build:flipper-server
```
Pass the `--open` flag to open Flipper server after building
Use `--no-rebuild-plugins` to speed up subsequent builds if default plugins have been build already
### Test NPX build
```
cd <Flipper checkout>/desktop/
yarn build:flipper-server
cd flipper-server
yarn test:npx
```