Project Setup

STEP 1 - Pick a starter-kit

You can start setting up your project by picking the right starter-kit as per your need. Following are starter-kits currently available:

  • cra-full-demo/ This can be used to start with all the available components, features and services as presented in demo. If you want to explore features and functionalities Jumbo offers, this is the right place for you start.

  • cra-starter-kit/ This one is the recommended way to start your project from scratch as it offers the minimal required libraries and can be extended as per the requirement of your project.

Once you make your decision on picking the right starter-kit from above mentioned ones. Copy that folder and paste that to your desired location where you want to place your project.

STEP 2 - Installing the Dependencies

Open the command prompt and go inside the project folder you placed in step 1 through the CD command.

Once you are inside the project folder, run the following command to install the dependencies used in Jumbo:-

yarn install

Alternatively, you can open the folder in the development editor of your choice and run the above-written command in its terminal.

STEP 3 - Running the project on Local Server

After installing the dependencies, you can run the project on a local server by using the following command:-

yarn start

Step 4 - Preparing the Build of the Project (Optional)

The Build is used for presenting the offline demo of the project or putting the project on a live server. So this step is not mandatory if you want to run the project on localhost or in development mode.

To prepare the build of the project, run the following command:-

yarn build

The project will be built assuming it is hosted at /. You can control this with the homepage field in your package.json.

After the successful completion of this command, you will find a folder named "build" in the project files.

The "build" folder is ready to be deployed. You may serve it with a static server:

yarn global add serve -s build

Find out more about deployment here:

Last updated