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>
This commit is contained in:
Sudhanshu Gautam 2019-08-25 19:32:09 +05:30 committed by GitHub
parent 128855c278
commit 76da264e85
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,68 +1,34 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# OpenWrt Firmware Selector Wizard
## Available Scripts
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)
In the project directory, you can run:
## Features
### `npm start`
* Easily search devices
* Option to download Vanilla images
* Option to download custom images
Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Setting up
The page will reload if you make edits.<br>
You will also see any lint errors in the console.
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 ```
### `npm test`
## Deployment
Launches the test runner in the interactive watch mode.<br>
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
In order to deploy the web app, follow the following steps:
### `npm run build`
* For gh-pages:
1. ``` yarn deploy ```
2. Enable Github Pages setting to use gh-pages branch.
Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
* Elsewhere:
1. Build the app using:
``` yarn build ```
2. Host the files from `/build` directory.
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `npm run eject`
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
If you arent satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point youre on your own.
You dont have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
### Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
### Making a Progressive Web App
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
### Advanced Configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
### Deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
### `npm run build` fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify