This project was bootstrapped with Create React App.
When cloning this repo make sure to name your new repo with the naming convention defined below.
NOTE: Do NOT check Include all branches
.
contentstack-extension-<component-name-slug>
Follow the instructions here to install NVM on your local machine and hock it into your terminal.
npm install
- Change the
PUBLIC_URL
to point to S3 path location the component will be deployed to. - Specificically
<component-repo-name>
should be replaced with the slug version of the component name.
- Update the
title
to relect the component name. - Update the meta
description
with a proper description of the components purpose.
- Update the
short_name
to relect the component name. - Update the meta
name
with a proper complete name of the component.
- Update
name
to reflect repo name of the new component. The name should be in the form@shopsmart/<component-repo-name>
. - Add
description
to describe custom component.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Runs all available linting tools for JS, HTML, & CSS
To learn about Contentstack UI SDK
To learn about implementing Contentstack Venus Library Components
To see Venus library components Venus Storybook
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.