openwrt-firmware-selector/README.md
Sudhanshu Gautam 76da264e85
Update README.md (#13)
Add the instructions for development environment setup and
for deploying to server.
Also add relevant information.

Signed-off-by: Sudhanshu Gautam <me@sudhanshug.com>
2019-08-25 19:32:09 +05:30

34 lines
921 B
Markdown

# OpenWrt Firmware Selector Wizard
The wizard utilises the changes proposed [here](https://github.com/openwrt/openwrt/pull/2192).
Along with this, the feature to build custom images utilises [Attended Sysupgrade Server](https://github.com/aparcar/attendedsysupgrade-server)
## Features
* Easily search devices
* Option to download Vanilla images
* Option to download custom images
## Setting up
You can set it up easily:
1. Clone the repository
2. Use [yarn](https://yarnpkg.com/en/) to install package dependencies
``` yarn install ```
3. Use the following command to start a dev server:
``` yarn start ```
## Deployment
In order to deploy the web app, follow the following steps:
* For gh-pages:
1. ``` yarn deploy ```
2. Enable Github Pages setting to use gh-pages branch.
* Elsewhere:
1. Build the app using:
``` yarn build ```
2. Host the files from `/build` directory.