mirror of
https://git.netzspielplatz.de/docker-multiarch/openwrt-firmware-selector.git
synced 2025-11-08 20:39:25 +00:00
Update README
This commit is contained in:
parent
897edca49d
commit
a897ffb71e
2 changed files with 24 additions and 34 deletions
58
README.md
58
README.md
|
|
@ -1,46 +1,36 @@
|
|||
# Getting Started with Create React App
|
||||
# OpenWrt Firmware Selector Wizard
|
||||
|
||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||||
A simple OpenWrt firmware selector using autocompletion.
|
||||
|
||||
## Available Scripts
|
||||
## Features
|
||||
|
||||
In the project directory, you can run:
|
||||
- Easily search devices
|
||||
- Option to download Vanilla images
|
||||
- Option to download custom images
|
||||
|
||||
### `yarn start`
|
||||
## Setting up
|
||||
|
||||
Runs the app in the development mode.\
|
||||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
||||
You can set it up easily:
|
||||
|
||||
The page will reload if you make edits.\
|
||||
You will also see any lint errors in the console.
|
||||
1. Clone the repository
|
||||
2. Use [yarn](https://yarnpkg.com/en/) to install package dependencies
|
||||
`yarn install`
|
||||
3. Run `scripts/collect.py` to generate required JSON files.
|
||||
4. Use the following command to start a dev server:
|
||||
`yarn start`
|
||||
|
||||
### `yarn test`
|
||||
## Deployment
|
||||
|
||||
Launches the test runner in the interactive watch mode.\
|
||||
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:
|
||||
|
||||
### `yarn build`
|
||||
- For gh-pages:
|
||||
|
||||
Builds the app for production to the `build` folder.\
|
||||
It correctly bundles React in production mode and optimizes the build for the best performance.
|
||||
1. `yarn deploy`
|
||||
2. Enable Github Pages setting to use gh-pages branch.
|
||||
|
||||
The build is minified and the filenames include the hashes.\
|
||||
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.
|
||||
|
||||
### `yarn eject`
|
||||
|
||||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
|
||||
|
||||
If you aren’t 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 you’re on your own.
|
||||
|
||||
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t 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/).
|
||||
## [LICENSE](LICENSE)
|
||||
|
|
|
|||
BIN
screenshot.png
BIN
screenshot.png
Binary file not shown.
|
Before Width: | Height: | Size: 112 KiB |
Loading…
Add table
Add a link
Reference in a new issue