Compass Starter App Installation Guide
The Contentstack Compass Starter app creates a sample stack using Next.js and Javascript SDK, allowing you to build your own applications with Next.js and Contentstack.
This step-by-step guide lets you import the Compass Starter application from Contentstack Marketplace and use it within your organization.
Prerequisites
- Contentstack account
- Access to the Contentstack Organization as the Owner/Admin
- Launch enabled for your organization
- Branches enabled for your organization
- Live Preview enabled for your organization
Let's follow this step-by-step guide to import the Compass Starter app within your organization.
Import Compass Starter from Contentstack Marketplace
Follow the steps to import the Compass Starter in your organization.
- Log in to your Contentstack account.
- In the left-hand side primary navigation, click the Marketplace icon to go to the Marketplace. Click to enlarge
- Click Starters in the left panel.
- Within the Marketplace, you can see all the available starters. Hover over the Compass Starter and click Import. Click to enlarge
- In the popup window, scroll down to the bottom of the window and then click Authorize to import the Compass Starter app.Click to enlargeThis will set up and load your Starter stack.
- Click the Go back to Marketplace button to return to the Marketplace. Click to enlarge
- Click the Stacks icon in the left panel. Click to enlargeYou will see a stack named Compass Starter created with imported content in the selected organization.
NoteIt takes a few minutes for the stack to get created with the imported data.
Click to enlarge
Support for Launch
After the Compass Starter stack gets successfully created with all the content, a Launch project will be created, followed by the project deployment. This deployment takes a few minutes.
- Click the Launch icon in the left panel. Click to enlargeYou will see that a Launch project is already created and deployed.Click to enlarge
Support for Branches
Compass Starter lets you work under different Branches of your stack.
- Click the Stacks icon in the left panel and then click the Compass Starter stack.
You will be in the main branch by default.Click to enlarge
Support for Live Preview
Compass Starter lets you view the Live Preview of your website.
- Click the Compass Starter stack and then click the Entries icon in the left panel. Click to enlarge
- Select an entry from the list.
- To view the Live Preview of the website, click the Live Preview button in the right panel of the entry as shown below: Click to enlarge
You can now get started with Contentstack!