Skip to content

Commit a6add6b

Browse files
Update readme
1 parent 46307f7 commit a6add6b

File tree

3 files changed

+45
-58
lines changed

3 files changed

+45
-58
lines changed

README.md

Lines changed: 24 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,35 @@
1-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
1+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
22

3-
## Available Scripts
3+
# react-app-template
44

5-
In the project directory, you can run:
5+
A template for react app using create-react-app and some customizations.
66

7-
### `yarn start`
7+
## Installation
88

9-
Runs the app in the development mode.<br />
10-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
9+
```bash
10+
git clone https://github.com/completejavascript/react-app-template.git YourProjectName # Clone the project
11+
cd YourProjectname
12+
rm -rf .git # So you can have your own changes stored in VCS.
13+
yarn # Install dependencies
14+
yarn start # Start development
15+
```
1116

12-
The page will reload if you make edits.<br />
13-
You will also see any lint errors in the console.
17+
Navigate to localhost:3000.
1418

15-
### `yarn test`
19+
## Features
1620

17-
Launches the test runner in the interactive watch mode.<br />
18-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
21+
* Style React component with [SASS](https://sass-lang.com/)
22+
* Use [customize-cra](https://github.com/arackaf/customize-cra) to customize CRA without **eject**.
23+
* Use [hookrouter](https://github.com/Paratron/hookrouter) - the flexible, and fast router for react that is entirely based on hooks - for using router faster.
24+
* Use [react-intl](https://github.com/formatjs/react-intl) to internationalize React apps.
25+
* Use [react-redux](https://react-redux.js.org/) to manage App state.
26+
* Use [js-cookie](https://github.com/js-cookie/js-cookie) for handling browser cookies.
27+
* Use [axios](https://github.com/axios/axios) for HTTP requests.
1928

20-
### `yarn build`
29+
## Author
2130

22-
Builds the app for production to the `build` folder.<br />
23-
It correctly bundles React in production mode and optimizes the build for the best performance.
31+
* [Lam Pham](http://about.phamvanlam.com)
2432

25-
The build is minified and the filenames include the hashes.<br />
26-
Your app is ready to be deployed!
33+
## License
2734

28-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
29-
30-
### `yarn eject`
31-
32-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
33-
34-
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.
35-
36-
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.
37-
38-
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.
39-
40-
## Learn More
41-
42-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
43-
44-
To learn React, check out the [React documentation](https://reactjs.org/).
45-
46-
### Code Splitting
47-
48-
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
49-
50-
### Analyzing the Bundle Size
51-
52-
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
53-
54-
### Making a Progressive Web App
55-
56-
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
57-
58-
### Advanced Configuration
59-
60-
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
61-
62-
### Deployment
63-
64-
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
65-
66-
### `yarn build` fails to minify
67-
68-
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
35+
This project is open source and available under the MIT License.

netlify.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[build]
2+
publish = "public"
3+
command = "yarn run build"
4+
[build.environment]
5+
YARN_VERSION = "1.21.0"

package.json

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"name": "react-app-template",
3+
"description": "Template for react app using create-react-app and some customizations.",
34
"version": "0.1.0",
4-
"private": true,
5+
"author": "Lam Pham <completejavascript.super@gmail.com>",
56
"dependencies": {
67
"@testing-library/jest-dom": "^4.2.4",
78
"@testing-library/react": "^9.3.2",
@@ -21,6 +22,20 @@
2122
"redux": "^4.0.5",
2223
"redux-thunk": "^2.3.0"
2324
},
25+
"keywords": [
26+
"react",
27+
"react-js",
28+
"customize-cra",
29+
"react app template",
30+
"sass",
31+
"hookrouter",
32+
"react intl",
33+
"react redux",
34+
"js-cookie",
35+
"axios"
36+
],
37+
"license": "MIT",
38+
"main": "n/a",
2439
"scripts": {
2540
"start": "react-app-rewired start",
2641
"build": "react-app-rewired build",

0 commit comments

Comments
 (0)