chore(README.md): add more comprehensive instructions for developing application kit bundles in readme #2346

ByronDWall · 2021-08-20T20:16:52Z

Summary

Updates readme with more detailed instructions for setting up the development environment for application kit bundles.

Description

Adds more detailed direction regarding initially installing this repo and setting it up to watch the app-kit bundles and the playground

…the application kit bundles in readme

changeset-bot · 2021-08-20T20:16:54Z

⚠️ No Changeset found

Latest commit: 7fef0fa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2021-08-20T20:16:54Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/commercetools/merchant-center-application-kit/7ssK8sTdSc62bctMNWUsJ3tpJ555
✅ Preview: https://merchant-center-application-kit-git-update-ba87f1-commercetools.vercel.app

wrsenn · 2021-08-20T20:22:34Z

README.md

+
+2. Add necessary environment variables
+
+   > In the vscode file tree or the terminal, navigate to `merchant_center_application_kit/playground`, open `.env.local.template`, and add these values:


This file shouldn't be modified––you'll want to duplicate it and rename to .env.local instead. No need to specify the method you'll use to do it, either; I'm sure there's an Emacs user in the org somewhere 😉

good point, changed in most recent commit

README.md

mohib0306 · 2021-08-23T13:44:32Z

README.md

+   ```bash
+     MC_API_URL="https://mc-api.europe-west1.gcp.commercetools.com" # for prod
+     APP_ID="" # can be an empty string for dev
+     CTP_INITIAL_PRODUCT_KEY=<your-project-name> # the name of any project you have access to on prod/stage


this should be CTP_INITIAL_PROJECT_KEY

indeed it should be, thanks!

…CT_KEY

…ng the fake permission

emmenko

Thanks for trying to improve the docs. I find some of the suggestions confusing though and I think we only need to mention a couple of things. That should be enough.

Can you take another look? Thanks

emmenko · 2021-09-21T15:11:56Z

README.md

+
+3. Build and run the application kit
+
+   > In a new terminal window, navigate to the project root directory - `/merchant_center_application_kit` - and run:


Suggested change

> In a new terminal window, navigate to the project root directory - `/merchant_center_application_kit` - and run:

> In a new terminal window, navigate to the project root directory and run:

emmenko · 2021-09-21T15:14:28Z

README.md

+   > In a new terminal window, navigate to the project root directory - `/merchant_center_application_kit` - and run:
+
+   ```bash
+   $ yarn && yarn prebuild && yarn build && yarn build:watch


This command does not make much sense. Simply run build.

Suggested change

$ yarn && yarn prebuild && yarn build && yarn build:watch

$ yarn build

FYI: prebuild is automatically executed when the build command is executed. Every npm script that starts with pre<name of command> does that.

emmenko · 2021-09-21T15:15:20Z

README.md

+### Initial Installation
+
+1. Clone this repo
+
+   ```bash
+   $ git clone https://github.com/commercetools/merchant-center-application-kit.git
+   ```


I would omit this part to be honest, it does not seem relevant.

emmenko · 2021-09-21T15:17:08Z

README.md

+4. Remove fake permission:
+   > `PERMISSIONS.ViewPlaygroundStateMachines` which is required by playground is a fake permission and you might need to remove it
+   > in order to be able to run and view the application. You'll need to remove it twice in `custom-application-config.mjs` and once in
+   > `routes.js` so that `permissions`/`demandedPermissions` are just empty objects:
+
+`custom-application-config.mjs`


I'm not sure I understand this point. Why fake?

@emmenko
"Fake" might not be the best terminology but without removing them in those two files you cannot access the playground (see screenshot). Fedor helped me discover this and he called them fake permissions which is why I used that term but I can change it if there's a better alternative. We were curious though why they were there in the first place and if they needed to be removed permanently?

emmenko · 2021-09-21T15:17:36Z

README.md

+ permissions: [PERMISSIONS.ViewPlaygroundStateMachines],
+ submenuLinks: [
+    {
+      uriPath: 'echo-server',
+      permissions: [PERMISSIONS.ViewPlaygroundStateMachines],
+      defaultLabel: '${intl:en:Menu.EchoServer}',
+      labelAllLocales: [
+        {
+          locale: 'en',
+          value: '${intl:en:Menu.EchoServer}',
+        },
+        {
+          locale: 'de',
+          value: '${intl:de:Menu.EchoServer}',
+        },
+      ],
+    },
+  ],


The custom app config does not need to change. You can omit this.

README.md

emmenko · 2021-09-21T15:23:06Z

README.md

@@ -23,40 +23,119 @@ $ npx @commercetools-frontend/create-mc-app my-new-custom-application-project --

 ## Developing application-kit packages

-Install the dependencies (uses yarn workspaces):
+### Initial Installation


This all section can be removed to be honest. We can mention to check and ensure to have the .env.local file but I wouldn't document its content. Instead you can add more information and give hints in the template file itself.

@emmenko
When you initially pull down the repo this is the result when you run yarn build:watch after adding the environment variables without running yarn build first.

…of github.com:commercetools/merchant-center-application-kit into update-readme-developing-application-kit-bundles-docs

…g playground application from a fresh pull of the repository

emmenko · 2021-09-22T19:46:06Z

@jmcreasman @ByronDWall I see that there is still some confusion about this. Let's maybe have a 1:1 chat and I'll explain a bit more how things are supposed to work.

ByronDWall · 2021-09-22T19:49:19Z

I see that there is still some confusion about this. Let's maybe have a 1:1 chat and I'll explain a bit more how things are supposed to work.

@emmenko I think a 1:1 chat would be helpful, thanks for taking the time to look things over and review

chore(README.md): add more comprehensive instructions for developing …

6486a18

…the application kit bundles in readme

ByronDWall added the ✍️ Type: Documentation label Aug 20, 2021

wrsenn reviewed Aug 20, 2021

View reviewed changes

ByronDWall commented Aug 20, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

8d2d1fb

vercel bot temporarily deployed to Preview August 20, 2021 20:49 Inactive

chore(README.md): update docs for consistency/readablility

fc07510

vercel bot temporarily deployed to Preview August 20, 2021 22:31 Inactive

chore(README.md): fix typos and indentation in readme

1b53cf8

vercel bot temporarily deployed to Preview August 23, 2021 12:58 Inactive

mohib0306 reviewed Aug 23, 2021

View reviewed changes

chore(README.md): it's CTP_INITIAL_PROJECT_KEY, not CTP_INITIAL_PRODU…

b800d3c

…CT_KEY

vercel bot temporarily deployed to Preview August 23, 2021 13:56 Inactive

chore(README.md): update documentation with another step about removi…

6c40c94

…ng the fake permission

vercel bot temporarily deployed to Preview August 30, 2021 14:42 Inactive

chore(README.md): update documentation with another step about removi…

33da242

…ng the fake permission

vercel bot temporarily deployed to Preview August 30, 2021 14:54 Inactive

chore(README.md): update documentation with another step about removi…

101b461

…ng the fake permission

vercel bot temporarily deployed to Preview August 30, 2021 15:02 Inactive

emmenko requested changes Sep 21, 2021

View reviewed changes

ByronDWall added 2 commits September 21, 2021 15:04

Merge branch 'update-readme-developing-application-kit-bundles-docs' …

07ed52e

…of github.com:commercetools/merchant-center-application-kit into update-readme-developing-application-kit-bundles-docs

chore(README.md): update README based on feedback and retrying runnin…

7fef0fa

…g playground application from a fresh pull of the repository

vercel bot temporarily deployed to Preview September 21, 2021 19:20 Inactive

vercel bot temporarily deployed to Preview September 21, 2021 19:27 Inactive

ByronDWall force-pushed the update-readme-developing-application-kit-bundles-docs branch from 9c0fac1 to 7fef0fa Compare September 21, 2021 19:33

emmenko marked this pull request as draft December 1, 2021 09:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(README.md): add more comprehensive instructions for developing application kit bundles in readme #2346

chore(README.md): add more comprehensive instructions for developing application kit bundles in readme #2346

ByronDWall commented Aug 20, 2021

changeset-bot bot commented Aug 20, 2021 •

edited

vercel bot commented Aug 20, 2021 •

edited

wrsenn Aug 20, 2021

ByronDWall Aug 20, 2021

mohib0306 Aug 23, 2021

ByronDWall Aug 23, 2021

emmenko left a comment

emmenko Sep 21, 2021

emmenko Sep 21, 2021

emmenko Sep 21, 2021

emmenko Sep 21, 2021

jmcreasman Sep 21, 2021 •

edited

emmenko Sep 21, 2021

emmenko Sep 21, 2021

jmcreasman Sep 21, 2021

emmenko commented Sep 22, 2021

ByronDWall commented Sep 22, 2021


		2. Add necessary environment variables

		> In the vscode file tree or the terminal, navigate to `merchant_center_application_kit/playground`, open `.env.local.template`, and add these values:


		3. Build and run the application kit

		> In a new terminal window, navigate to the project root directory - `/merchant_center_application_kit` - and run:

	$ yarn && yarn prebuild && yarn build && yarn build:watch
	$ yarn build

chore(README.md): add more comprehensive instructions for developing application kit bundles in readme #2346

Are you sure you want to change the base?

chore(README.md): add more comprehensive instructions for developing application kit bundles in readme #2346

Conversation

ByronDWall commented Aug 20, 2021

Summary

Description

changeset-bot bot commented Aug 20, 2021 • edited

⚠️ No Changeset found

vercel bot commented Aug 20, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emmenko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmcreasman Sep 21, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emmenko commented Sep 22, 2021

ByronDWall commented Sep 22, 2021

changeset-bot bot commented Aug 20, 2021 •

edited

vercel bot commented Aug 20, 2021 •

edited

jmcreasman Sep 21, 2021 •

edited