Skip to content

Commit 3229aac

Browse files
authored
Update README.md
1 parent 48e207a commit 3229aac

File tree

1 file changed

+39
-46
lines changed

1 file changed

+39
-46
lines changed

README.md

Lines changed: 39 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,61 @@
1-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
1+
# React + Redux + AdminLTE Boilerplate
22

3-
## Available Scripts
43

5-
In the project directory, you can run:
4+
## Gears
5+
* [ReactJS](https://reactjs.org)
6+
* [Redux](http://redux.js.org)
7+
* [AdminLTE](https://adminlte.io)
8+
* [Bootstrap](https://getbootstrap.com/)
9+
* [JQuery](https://jquery.com/)
610

7-
### `npm start`
8-
9-
Runs the app in the development mode.<br />
10-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
11+
## Setup and running
1112

12-
The page will reload if you make edits.<br />
13-
You will also see any lint errors in the console.
14-
15-
### `npm test`
16-
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.
19-
20-
### `npm run build`
21-
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.
13+
Install dependencies using:
14+
```
15+
npm install
16+
```
2417

25-
The build is minified and the filenames include the hashes.<br />
26-
Your app is ready to be deployed!
18+
Base architecture was built using [create-react-app](https://github.com/facebookincubator/create-react-app), a great tool that build an app skeleton with all the great developing tools included, saving you from the pain to install and configure them individually.
2719

28-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
20+
Between included tools from Create React App there are Webpack, Babel for ES6 support, ESLint and others
2921

30-
### `npm run eject`
22+
Create React App defines some scripts in package.json
23+
* start
24+
* build
25+
* test
26+
* eject
3127

32-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
28+
You can run them using npm (they are almost all self explanatory)
3329

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).
30+
### `npm start`
4331

44-
To learn React, check out the [React documentation](https://reactjs.org/).
32+
Runs the app in the development mode.<br>
33+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
4534

46-
### Code Splitting
35+
The page will reload if you make edits.<br>
36+
You will also see any lint errors in the console.
4737

48-
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
38+
### `npm test`
4939

50-
### Analyzing the Bundle Size
40+
Launches the test runner in the interactive watch mode.
5141

52-
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
42+
### `npm run build`
5343

54-
### Making a Progressive Web App
44+
Builds the app for production to the `build` folder.
45+
It correctly bundles React in production mode and optimizes the build for the best performance.
5546

56-
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
47+
The build is minified and the filenames include the hashes.
48+
The app is ready to be deployed!
5749

58-
### Advanced Configuration
50+
**IMPORTANT: Do not run the eject script.**
5951

60-
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
52+
The eject script copies all configuration files from Webpack, Babel, ESlint etc to the project root, **BUT you can't go back**
53+
The only reason to run the eject script is if you are not happy with the default configuration provided by Create React App, but I don't think it will be the case.
6154

62-
### Deployment
55+
Please refer to the official documetation for more details.
6356

64-
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
57+
## Notes about AdminLTE
6558

66-
### `npm run build` fails to minify
59+
The theme folder contains a copy of the AdminLTE theme. Is there with all widget and pages examples. Use it as reference while building new Dashboard pages / UI.
6760

68-
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
61+
Actually in the public folder there are copies of bower_components, plugins and other javascripts and css files required by the theme

0 commit comments

Comments
 (0)