mines/frontend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

Updating the README.md

Browse Source
This commit is contained in:
Michel Wilhelm
2020-11-08 15:38:39 -03:00
parent 04738a47b8
commit 879f6d4b69
1 changed files with 26 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
README.md
View File

@@ -1,70 +1,38 @@
# Getting Started with Create React App # Minesweeper Frontend
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ### Stack used:
## Available Scripts - Javascript
- [ReactJS][stack/reactjs]
In the project directory, you can run: OpenAPI 3 documentation: [https://apidoc.mines.makecodes.dev/][url/apidoc]
Game frontend: [https://mines.makecodes.dev/][url/the-game]
Backend github repo: [https://github.com/imakecodes/minesweeper-backend][github/backend]
### `npm start` # Running locally
Runs the app in the development mode.\ ### Clone the repository
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\ ```bash
You will also see any lint errors in the console. git clone git@github.com:imakecodes/minesweeper-frontend.git
cd minesweeper-frontend
```
### `npm test` ### Install dependencies
Launches the test runner in the interactive watch mode.\ ```bash
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. npm install
```
### `npm run build` ### Run the application
Builds the app for production to the `build` folder.\ ```bash
It correctly bundles React in production mode and optimizes the build for the best performance. npm run start
```
The build is minified and the filenames include the hashes.\ The application will be available at [http://localhost:3000](http://localhost:3000)
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. [stack/reactjs]: https://reactjs.org/
[url/apidoc]: https://apidoc.mines.makecodes.dev/
### `npm run eject` [url/the-game]: https://mines.makecodes.dev/
[github/backend]: https://github.com/imakecodes/minesweeper-backend
**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](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](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](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](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](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](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)