Quick Start

Installation
Navigate to your root folder (i.e. dashboard-kit-react)
1
c:\>cd dashboard-kit-react
Copied!
Install Packages by npm or yarn as per your preferences. Here we are using yarn package manager.
1
c:\dashboard-kit-react> yarn
Copied!
Start
After package installation, you can start your app by using yarn start command
1
c:\dashboard-kit-react> yarn start
Copied!
This will start your local server at http://localhost:3000 Also, your terminal shows the following.
1
Compiled successfully!
2
​
3
You can now view dashboard-kit-react in the browser.
4
​
5
Local:            http://localhost:3000
6
On Your Network:  http://192.168.29.77:3000
7
​
8
Note that the development build is not optimized.
9
To create a production build, use yarn build.
Copied!
Dashboard-Kit is very huge with many components, so it will take little time when you run it for first time. Please do not stop execution if it takes time on first launch.
Build & Deploy
This might be too early to deploy but it is always good to know how to deploy.
To build your app in production use yarn build command
1
c:\DashboardKit-material-react> yarn build
2
or
3
c:\DashboardKit-material-react> npm run build
Copied!
Deploy for your live site
Change the base URL with your domain and build your application.
You can control this with the homepage field in your package.json
package.json
1
"homepage" : "http://example.com"
Copied!
To deploy it for subdirectory i.e http://example.com/subdirectory/
package.json
1
"homepage" : "http://example.com/subdirectory/"
Copied!
You also need to set base-name in config.js at '../src/config/'
config.js
1
basename: "/subdirectory";
Copied!
You’ll need to have Node v12.x.x or later on your local development machine (but it’s not required on the server). You can use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects.

Pre-requisites

Folder Structure

Last modified 6mo ago

Copy link

Contents

Installation

Start

Build & Deploy

Deploy for your live site