Skip to content
This repository was archived by the owner on Sep 7, 2021. It is now read-only.

Commit b4de415

Browse files
booleanhunterbooleanhunter
authored andcommitted
Updating README
1 parent 1b26940 commit b4de415

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# ReactJS-AdminLTE
22

3-
ReactJS version of the original AdminLTE dashboard - https://github.com/almasaeed2010/AdminLTE
3+
ReactJS version of the original AdminLTE dashboard - https://github.com/almasaeed2010/AdminLTE. This project consists of widgets, charts and other components written in ReactJS. Stylesheets are borrowed from the AdminLTE project.
4+
5+
If you use React in your app, you might find some of these components useful!
46

57

68
### UPDATES:
@@ -35,12 +37,14 @@ Will soon be populated with charts.
3537

3638
More stuff coming soon. Stay tuned!
3739

40+
##### Due to several work related commitments, the development rate is a little slow and I apologize for that. However, I'm looking for awesome folks :metal: who could contribute and help me maintain this project. If you have any queries that you may have on how to contribute, or you have just general questions about how to use the components in your app - feel free to shoot an email. I'll help you out! :smile_cat:
41+
3842

3943
#### Instructions to run
4044

41-
- Fork or clone this repo
45+
- Fork or clone this repo. Alternatively - if you have NPM installed, you can also do `npm install adminlte-reactjs`.
4246
- Install nodejs and NPM
43-
- Go to the project folder reactjs-adminlte from your terminal and run `npm install`
47+
- Go to the project's root folder from your terminal and run `npm install`
4448
- Run `node server.js`
4549
- Going to [http://localhost:8000](http://localhost:8000) will render an empty dashboard skeleton in the client-side using ReactJS. Clicking on one of the dashboard options on the left pane displays the original dashboards from AdminLTE.
4650
- Go to [http://localhost:8000/widgets.html](http://localhost:8000/widgets.html) to see available widgets in ReactJS.
@@ -66,13 +70,12 @@ change this to
6670
<script src="http://localhost:8080/dist/js/app.bundle.js"></script>
6771
```
6872

69-
For a detailed explanation on setting up a workflow using Webpack, check out my blog post - [Webpack for The Fast and The Furious](https://medium.com/@booleanhunter/webpack-for-the-fast-and-the-furious-bf8d3746adbd#.uzx2l0hy4) :-)
73+
For a detailed explanation on setting up a workflow using Webpack, check out my blog post - [Webpack for The Fast and The Furious](https://medium.com/@booleanhunter/webpack-for-the-fast-and-the-furious-bf8d3746adbd#.uzx2l0hy4) :oncoming_police_car:
7074

71-
This is still a work in progress and will get better over time. Will try and think of more essential features. Looking for feedback and contributions! For any discussions or queries, send an email.
75+
This is still a work in progress and will get better over time. Will try and think of more essential features.
7276

7377
#### Upcoming stuff
7478

7579
- Re-usable chart components
7680
- Command line options to choose between client-side rendering and server-side rendering in ReactJS
77-
- Including D3 / C3 charts
78-
81+
- Including D3 / C3 charts

0 commit comments

Comments
 (0)