doc: update project information and readme

- complete package infomation
- update readme, guide users to use this project
pull/4/head
kairee 7 years ago
parent 9097c1b416
commit a0d2b1c71b
No known key found for this signature in database
GPG Key ID: 2739DB6AFA7BC8F9

@ -1,44 +1,33 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
# Web UI for ServerStatus
## Available Scripts
This is a web ui for [BotoX's ServerStatus](https://github.com/BotoX/ServerStatus/).
In the project directory, you can run:
## Live demo:
### `npm start`
[https://udev.bid/sergate/](https://udev.bid/sergate/)
Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Useage:
The page will reload if you make edits.<br>
You will also see any lint errors in the console.
### **With release version:**
### `npm test`
1. Download the latest prebuilt files on the [release page](https://github.com/krwu/ServerStatus-web/releases).
2. Unzip the downloaded file.
3. Copy all files in `sergate` directory to your web directory of ServerStatus(you can delete all files except `json/status.json` in it, this is recommended).
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.
### **Built by your self:**
### `npm run build`
1. You need Node.js, npm / yarn installed.
2. Clone the repo to your machine.
3. Enter the root directory of this project.
4. Install dependecies with npm / yarn.
5. Run `npm run build` to build web files.
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.
``` bash
git clone https://github.com/krwu/ServerStatus-web.git
cd ./ServerStatus-web/
## you can also run "yarn" instead of the next command
npm i
npm run build
```
6. Copy all files in the `build` directory to your web directory of ServerStatus(you can delete all files except `json/status.json` in it, this is recommended).
The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
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 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/).

14038
package-lock.json generated

File diff suppressed because it is too large Load Diff

@ -1,8 +1,25 @@
{
"name": "sergate",
"version": "0.1.0",
"name": "serverstatus-webui",
"version": "1.0.0",
"description": "It's a simple, clean webui for ServerStatus, built with react and Ant Design",
"keywords": [
"ServerStatus",
"Web UI",
"sergate",
"react",
"ant design"
],
"private": true,
"homepage" : "https://udev.bid/sergate",
"homepage": ".",
"bugs": {
"url": "https://github.com/krwu/ServerStatus-web/issues"
},
"license": "MIT",
"author": "Kairee <kairee@udev.bid> (https://www.ofcss.com/)",
"repository": {
"type": "git",
"url": "https://github.com/krwu/ServerStatus-web.git"
},
"dependencies": {
"@types/jest": "24.0.17",
"@types/node": "12.7.1",

Loading…
Cancel
Save