React.js Starter

Note: This starter app uses Live Preview version 2.0.

Prerequisites

• Contentstack account
• Node.js version 20 or later
• Contentstack CLI: npm install -g @contentstack/cli
• Enable Live Preview for your organization
• Management token with read permission

Note: For this tutorial, you must be familiar with Contentstack, React.js, and the Bootstrap plugin in Contentstack CLI. To learn more, refer to the Contentstack, React.js and Bootstrap Starter Apps using CLI documentation.

Supported Features

• Launch Hosting: Seamlessly deploy your website using our Launch hosting platform. Refer to the Launch documentation to learn more about hosting on Launch.
• Live Preview: Utilize Contentstack's Live Preview feature to see real-time updates of your content changes reflected on your site before publishing.
• Branches: Leverage the Branches feature to manage different versions of your content within Contentstack, allowing for organized development and deployment.

Set Up Your App Using Marketplace

To import this starter, log in to your Contentstack account and follow the steps below:

1. Navigate to Marketplace from the left-hand side primary navigation, and click Starters.
2. You can see the available starters. Hover over the React starter and click Import.

Additional Resource: For more details, refer to the Importing a Starter documentation.

Set Up Your App Using CLI

Here is an overview of the steps involved in creating our React.js app:

1. Set the Region
2. Login to your Account
3. Import Content
4. Create Delivery Token
5. Build and Configure the Website
6. Deploy the Website

1. Set the Region

   To specify your region (North America, Europe, Azure North America, Azure Europe, Google North America, or Google Europe), run the following command in your terminal (command prompt):

   csdx config:set:region <<region>>

   Note:

   • North America: Set the region as NA.
   • Europe: Set the region as EU.
   • Azure North America: Set the region as AZURE-NA.
   • Azure Europe: Set the region as AZURE-EU.
   • Google Cloud Platform North America: Set the region as GCP-NA.
   • Google Cloud Platform Europe: Set the region as GCP-EU.

2. Login to your Account

   To import the prebuilt content to your stack, you need to log in to your Contentstack account via CLI by running the following command in your terminal:

   csdx auth:login

   This command requests you to provide your Contentstack’s account credentials (email and password).

3. Import Content

   The seed command lets you import content to your stack in a few steps. To do so, run the following command in your terminal:

   csdx cm:stacks:seed --repo "contentstack/stack-starter-app"

   This command prompts the following options:

   • Organization name: You will see a list of organizations you have access to. Select the one that contains your source stack, or where you want to create a new stack.

     Note: Select an organization where you have Owner or Admin permissions.

   • Stack preference: Next, you will get an option to create a new stack or use an existing one:
     • If you select New, you must enter the stack name, and the stack creation process will start.
     • If you select Existing, you will see a list of stacks you have access to in the organization. Choose the destination stack where you want to import the content. If the existing stack has some content, it will ask for a confirmation to continue with the same stack.

       Additional Resource: Refer to the Stack Roles documentation to learn more about permissions.

   Tip: To avoid the chances of any error, we recommend that you select the option of creating a new destination stack. If you import content to an existing stack, ensure that the stack is empty.

   Finally, you will get the content imported to your stack.

4. Create Delivery Token

   Delivery tokens are used to fetch published content from a specific environment.

   You can create a delivery token for the development environment for running the website on localhost. Later, while deploying your site, you can create tokens for other environments.

5. Build and Configure the Website

   Download the website code

   Fire up your terminal, navigate to your project folder, and run the following command to create a configuration file named .env.

   cp .env.example .env

   Note: If you are a Windows user, replace cp with copy in the command given above.

   The .env file contains all the necessary config parameters. Open it in any code editor or IDE of your choice, provide your stack credentials as shown below, and save the file.

   REACT_APP_CONTENTSTACK_API_KEY=<api_key_of_your_stack>
   REACT_APP_CONTENTSTACK_DELIVERY_TOKEN=<delivery_token_of_the_environment>
   REACT_APP_CONTENTSTACK_ENVIRONMENT=<environment_name>
   
   # By default branch=main, if a branch is not provided
   # REACT_APP_CONTENTSTACK_BRANCH=<your_branch_name>
   
   # By default region=us, if a region is not provided 
   # REACT_APP_CONTENTSTACK_REGION=<your_region_name>

   Mandatory configuration parameters to enable Live Preview

   Note: The below code is for North America region users only. Refer the configuration code for Europe region, Azure North America region, Azure Europe region, Google North America, and Google Europe region on the regions configuration page.

   REACT_APP_CONTENTSTACK_PREVIEW_TOKEN=<preview_token_linked_to_the_delivery_token>
   REACT_APP_CONTENTSTACK_APP_HOST=app.contentstack.com 
   REACT_APP_CONTENTSTACK_API_HOST=api.contentstack.io 
   #REACT_APP_CONTENTSTACK_PREVIEW_HOST=rest-preview.contentstack.com
   REACT_APP_CONTENTSTACK_LIVE_PREVIEW=true 
   #By default the live preview feature is enabled for this project. To disable it, set "REACT_APP_CONTENTSTACK_LIVE_PREVIEW=false".
   REACT_APP_CONTENTSTACK_LIVE_EDIT_TAGS=false 
   #By default live editing tags are disabled for this project. To enable it, set “REACT_APP_CONTENTSTACK_LIVE_EDIT_TAGS=true”. 

   Note: Make sure your management token has READ permission only.

   Additional Resource: Go to our Live Preview documentation to learn more about the Live Preview and Live Editing features in Contentstack.

   Run the following commands to start your website

   npm install
   npm start

   That’s it!

   You can now view the website at http://localhost:3000. And you also have the stack that has all the content and resources for the website. Try experimenting by creating new entries and publishing on the “development” environment. You should be able to see the changes on the website at the localhost.

   Set up Live Preview (Optional)

   Note: In order to use Live Preview, your plan must include this feature. Check our pricing page for more details. 

   The next step is to set up and enable live preview and live editing for your website. Follow the steps below to set up live preview feature for your website:

   1. Navigate to the Live Preview section in your stack's “Settings”.
   2. Select the Enable Live Preview checkbox.
   3. Now, select a Default Preview Environment for previewing the live content of your website. Finally, Save your settings.

   This completes your live preview set up. Now, you can deploy the website using Vercel.

6. Deploy the Website

   The easiest way to deploy a React.js starter website to production is by using Contentstack Launch, Contentstack’s web hosting platform. For more details, refer to the Contentstack Launch documentation.
   Alternatively, you can use Vercel to host your website. To do so, you need a Vercel account before deploying.

   Note: When deploying the starter website, enable or disable the Live Preview environment variable as needed.