-
Notifications
You must be signed in to change notification settings - Fork 147
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial commit of Salesforce Commerce Cloud app.
- Loading branch information
1 parent
d0655fb
commit cdd32a5
Showing
31 changed files
with
10,364 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# dependencies | ||
/node_modules | ||
|
||
# testing | ||
/coverage | ||
|
||
# production | ||
/dist | ||
|
||
# misc | ||
.DS_Store | ||
|
||
# eslint | ||
.eslintrc.json | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
.env* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
This project was bootstrapped with [Create Contentful App](https://github.com/contentful/create-contentful-app). | ||
|
||
## How to use | ||
|
||
Execute create-contentful-app with npm, npx or yarn to bootstrap the example: | ||
|
||
```bash | ||
# npx | ||
npx create-contentful-app --example vite-react | ||
|
||
# npm | ||
npm init contentful-app --example vite-react | ||
|
||
# Yarn | ||
yarn create contentful-app --example vite-react | ||
``` | ||
|
||
## Available Scripts | ||
|
||
In the project directory, you can run: | ||
|
||
#### `npm start` | ||
|
||
Creates or updates your app definition in Contentful, and runs the app in development mode. | ||
Open your app to view it in the browser. | ||
|
||
The page will reload if you make edits. | ||
You will also see any lint errors in the console. | ||
|
||
#### `npm run build` | ||
|
||
Builds the app for production to the `dist` 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! | ||
|
||
#### `npm run upload` | ||
|
||
Uploads the `dist` folder to Contentful and creates a bundle that is automatically activated. | ||
The command guides you through the deployment process and asks for all required arguments. | ||
Read [here](https://www.contentful.com/developers/docs/extensibility/app-framework/create-contentful-app/#deploy-with-contentful) for more information about the deployment process. | ||
|
||
#### `npm run upload-ci` | ||
|
||
Similar to `npm run upload` it will upload your app to contentful and activate it. The only difference is | ||
that with this command all required arguments are read from the environment variables, for example when you add | ||
the upload command to your CI pipeline. | ||
|
||
For this command to work, the following environment variables must be set: | ||
|
||
- `CONTENTFUL_ORG_ID` - The ID of your organization | ||
- `CONTENTFUL_APP_DEF_ID` - The ID of the app to which to add the bundle | ||
- `CONTENTFUL_ACCESS_TOKEN` - A personal [access token](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens) | ||
|
||
## Libraries to use | ||
|
||
To make your app look and feel like Contentful use the following libraries: | ||
|
||
- [Forma 36](https://f36.contentful.com/) – Contentful's design system | ||
- [Contentful Field Editors](https://www.contentful.com/developers/docs/extensibility/field-editors/) – Contentful's field editor React components | ||
|
||
## Using the `contentful-management` SDK | ||
|
||
In the default create contentful app output, a contentful management client is | ||
passed into each location. This can be used to interact with Contentful's | ||
management API. For example | ||
|
||
```js | ||
// Use the client | ||
cma.locale.getMany({}).then((locales) => console.log(locales)); | ||
``` | ||
|
||
Visit the [`contentful-management` documentation](https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library) | ||
to find out more. | ||
|
||
## Learn More | ||
|
||
[Read more](https://www.contentful.com/developers/docs/extensibility/app-framework/create-contentful-app/) and check out the video on how to use the CLI. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8" /> | ||
<meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
</head> | ||
|
||
<body> | ||
<noscript>You need to enable JavaScript to run this app.</noscript> | ||
<div id="root"></div> | ||
<script type="module" src="/src/index.tsx"></script> | ||
<!-- | ||
This HTML file is a template. | ||
If you open it directly in the browser, you will see an empty page. | ||
You can add webfonts, meta tags, or analytics to this file. | ||
The build step will place the bundled scripts into the <body> tag. | ||
To begin the development, run `npm start`. | ||
To create a production bundle, use `npm run build`. | ||
--> | ||
</body> | ||
</html> |
Oops, something went wrong.