-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
19 additions
and
57 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 |
|---|---|---|
| @@ -1,68 +1,30 @@ | ||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| # Toontown Rewritten Information Dashboard | ||
|
|
||
| ## Available Scripts | ||
| A modern electron application which shows you the current status of [Toontown Rewritten](https://toon.town). | ||
|
|
||
| In the project directory, you can run: | ||
|  | ||
|
|
||
| ### `yarn start` | ||
| --- | ||
|
|
||
| Runs the app in the development mode.<br /> | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
| ## Features | ||
|
|
||
| The page will reload if you make edits.<br /> | ||
| You will also see any lint errors in the console. | ||
| - **Population Chart:** View the current population of each district with a nice pie chart. Labels are toggleable by simply clicking on their label in the legend. | ||
| - **Silly Meter Status:** View the progress of the Silly Meter, along with the current/winning/future teams and the time until the next update/expiration of the boost/start of the next cycle. | ||
| - **Invasions List:** A list of all active invasions. | ||
|
|
||
| ### `yarn test` | ||
| ## Planned features | ||
|
|
||
| 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. | ||
| - **Estimated Invasion End:** List the time of when an invasion will end. | ||
| - **Icons:** Minimal icons for invasions (cog type) and silly meter (teams) as well as an icon for the app itself (currently using the default electron one). | ||
| - **Notifications:** Notifications for new invasions. | ||
| - **Customization:** Customize the auto-refresh time, dark mode, etc. | ||
| - **Individual pages:** Have pages for individual items (such as only show the population). | ||
|
|
||
| ### `yarn build` | ||
| ## Built with | ||
|
|
||
| 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. | ||
| - [create-react-app](https://github.com/facebookincubator/create-react-app) | ||
| - [electron](https://github.com/electron/electron) | ||
|
|
||
| The build is minified and the filenames include the hashes.<br /> | ||
| Your app is ready to be deployed! | ||
| ## License | ||
|
|
||
| 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/). | ||
|
|
||
| ### 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 | ||
|
|
||
| ### `yarn build` fails to minify | ||
|
|
||
| This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify | ||
| This project is licensed under the GNU License - see the [LICENSE.md](https://github.com/darkhappy/ttrinfo-app/blob/master/LICENSE) file for details. |