3.1
Tokyo

Installation


Setup

Follow the instructions below in order to install the project dependencies and start a new browser instance.

  • Install Node.js
    Before proceeding you will need to have Node.js installed on your system. Download and install the latest stable version from https://nodejs.org/
  • Install NPM
    You will need to have the last stable version of NPM available. More informations about this package manager can be found at https://www.npmjs.com/
    To install NPM run the following in a command line:
    // the -g parameter install npm globally on your system
    
    npm install -g npm
  • Install Project Dependencies
    The project dependencies are defined in the package.json file. Run the command below inside the root folder to install the dependencies.
    cd application-folder
    
    npm install

Development Server

After finishing with the dependencies install process, you can start a local development server and view the project in your browser.

Inside the project folder run the following command. It takes a few minutes to complete the initial development build.

npm run start

When finished, a browser window will be opened at http://localhost:3000 and the terminal will show a message similar to the one below:

Compiled successfully!

You can now view tokyo-react-admin-dashboard in the browser.

  Local:            http://localhost:3000
  On Your Network:  http://192.168.1.215:3000

Note that the development build is not optimized.
To create a production build, use npm run build.

Production Build

When ready to launch in production your new project, run the following command in a command line opened in the project folder:

npm run build

This will create a production-ready build of your project. If the build completed successfully, you will see in your terminal window a message similar to the one below:

The project was built assuming it is hosted at /.
  You can control this with the homepage field in your package.json.
  
  The build folder is ready to be deployed.
  You may serve it with a static server:
  
    serve -s build
  
  Find out more about deployment here:
  
    https://cra.link/deployment