Implementation of onepirate theme in Typescript.

Author: rothbart

README.md

@@ -1,68 +1,19 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# onepirate-typescript
 
-## Available Scripts
+Thanks for stopping by! This project is an adaptation of the Material-UI [onepirate theme](https://material-ui.com/store/items/onepirate/) to Typescript, using [create-react-app](https://github.com/facebook/create-react-app) as a harness for building and testing. This code is distributed using the MIT license so feel free to use it in your own projects.
 
-In the project directory, you can run:
+I decided to open source this work while building the [Web Field Guide](https://field-guide.web.app/) and realizing it might be a nice contribution to the broader community. If you found this helpful please check out the [field guide](https://field-guide.web.app/) or drop me an [email](mailto:[email protected]).
 
-### `npm start`
+I tried to change as little as possible about the original implementation when working on this adaptation. I did end up adding react-router-dom to the project for navigation, but otherwise the only changes you should notice are places where I've added types and hints for Typescript compiler.
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+## Building and running locally
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+Once you clone this repo you can use `npm install` and the standard create-react-app scripts to run it locally:
 
-### `npm test`
-
-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.
-
-### `npm run build`
-
-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!
-
-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/).
-
-### 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
+```
+C:\onepirate-typescript> npm install
+...
+C:\onepirate-typescript> npm run build
+...
+C:\onepirate-typescript> npm start
+```