README.md

ReactJS-AdminLTE

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.

If you use React in your app, you might find some of these components useful!

Widgets will use velocity.js animations instead of the originally used JQuery animations wherever possible, for improved performance across all browsers and devices.

Instructions of Usage :

Include the stylesheets for the components, similar to the widgets page

Include the library var reactjsAdminlte = require('adminlte-reactjs'). You may prefer the AMD style or the import statement.

You can now begin using the components like this var ProfileCard = reactjsAdminlte.ProfileCard.

If you don't need all the components, then you can choose to include only specific ones rather than the entire library. This can reduce your JS bundle size significantly var StatTile = require('adminlte-reactjs/src/components/stat-tile')

Contributing guidelines :

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 🤘 who could contribute and help me maintain this project.

Where can you contribute? (starting from easy to relatively challenging)

Covering documentation for all the available components and how to use them (this is the easiest one, but quite important!)

Converting existing components into ES6/ECMAScript 2016

Writing tests for components. Similar to tests written in the React-Bootstrap project.

Reactifying the rest of the widgets, elements and pages from AdminLTE. Here are the steps to do this:

Step 1 :

Fork or clone this repo. Alternatively - if you have NPM installed, you can also do npm install adminlte-reactjs.

Install nodejs and NPM

Go to the project's root folder from your terminal and run npm install

Run npm run dev

Going to 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.

Step 2:

Pick a page from the AdminLTE project to reactify it, or some widget that hasn't been reactified yet.

If the page for it doesn't exist in the repo, create one for it in the views folder, and render the page by defining a route for it inside routes.js.

Create the entry point that renders the components inside /src/pages folder. Now you can begin writing your components and testing them!

To view and test your components on the page, add your entry point in webpack.config.js. Run webpack -p to generate the bundle for the page, and include the bundle and associated vendors for it in the page using script tags.

webpack-dev-server along with React Hot Loader can be used to ease your development workflow. This can be done by installing dev dependencies from package.json file. If you haven't, then run npm install webpack-dev-server and npm install react-hot-loader. Then in your HTML, change your javascript bundles' source paths to point to the webpack-dev-server proxy in your script tags. So if you have these bundles for example,

Then you can run webpack-dev-server --hot --inline just once - and every time you make any edits to your code and save it, the server will automatically create bundles and update the changes in the browser. This is highly recommended instead of running webpack -p every time you make some edit in your code. You can later change the script tags back once you stop webpack-dev-server.

Step 3: Including your new components in the library

After you've finished writing a component and testing it out, you can include it in the library.

Place/move your component inside the /src/components folder and include it inside widgets.src.js.

Run npm build to generate the library reactjsAdminlte.js. Your component will be included in the library!

To make sure that your component works correctly, test it out by including it in the page using the library.

Some tips before making a pull request

Make sure that you've pulled the latest commits into your fork.

Create a branch for your edits - that way the project maintainer can safely pull your code and test it out.

If it's your first P.R, it'll be easier if you begin with something small first instead of making huge changes in lots of files. It helps me understand what the P.R is about, and I could help you out with the rest of changes if needed. It'll also save you from spending lot of effort in doing something that might not be necessary.

An important thing to remember is to have a P.R that fixes one issue at a time, and not make changes to lot of files in the same P.R. This way it's easier to test the changes out and have a relatively clean commit log.

If you have any further 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! 😸