-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): update dev instructions
- Loading branch information
1 parent
303f596
commit 9f010fd
Showing
4 changed files
with
36 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,27 +27,35 @@ npm install | |
|
||
|
||
## Development Workflow | ||
Read the ["How to contribute and code of conduct"](CONTRIBUTING.md) documentation | ||
|
||
**Start a live-reload development server:** | ||
|
||
### Start a live-reload development server | ||
``` | ||
WEB_PATH="/" npm run dev | ||
npm run dev | ||
``` | ||
|
||
This will serve the LiMe App with hot reloading. By default it will proxy every backend request to http://10.13.0.1, the default ip address for LibreMesh nodes. | ||
|
||
**Generate a production build in `./build`:** | ||
If you already have a LibreMesh router reachable at any given IP address, let's say 10.5.0.9, you can use it as a backend with: | ||
|
||
``` | ||
WEB_PATH="/" npm run build --production | ||
env NODE_HOST=10.5.0.9 npm run dev | ||
``` | ||
|
||
> You can now deploy the contents of the `build` directory to production on github pages! | ||
> | ||
> Fork and `npm run deploy` | ||
If you want, you can also setup a virtual LibreMesh node following [lime-packages: TESTING.md](https://github.com/libremesh/lime-packages/blob/master/TESTING.md#development-with-qemu-virtual-machine), which will be available at http://10.13.0.1 by default. | ||
|
||
### Generate a production build | ||
``` | ||
npm run build:production | ||
``` | ||
Now you can copy the bundles to the router: | ||
|
||
## Router Installation | ||
``` | ||
ssh [email protected] "rm -rf /www/app/*" && scp -r ./build/* [email protected]:/www/app | ||
``` | ||
|
||
In order to install the software in the node, the node must have several ubus packages installed ( see https://github.com/libremesh/lime-packages). | ||
### Run tests | ||
``` | ||
npm run tests | ||
``` | ||
|
||
For develop you can run `WEB_PATH='/app' npm run build --production` and then copy the build folder to the /www/app directory of the node and go. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters