Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

ByronDWall
Copy link
Contributor

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

@changeset-bot
Copy link

changeset-bot bot commented Aug 20, 2021

⚠️ 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
Copy link

vercel bot commented Aug 20, 2021

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

README.md Outdated

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:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point, changed in most recent commit

README.md Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview August 20, 2021 20:49 Inactive
@vercel vercel bot temporarily deployed to Preview August 20, 2021 22:31 Inactive
@vercel vercel bot temporarily deployed to Preview August 23, 2021 12:58 Inactive
README.md Outdated
```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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be CTP_INITIAL_PROJECT_KEY

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed it should be, thanks!

@vercel vercel bot temporarily deployed to Preview August 23, 2021 13:56 Inactive
@vercel vercel bot temporarily deployed to Preview August 30, 2021 14:42 Inactive
@vercel vercel bot temporarily deployed to Preview August 30, 2021 14:54 Inactive
@vercel vercel bot temporarily deployed to Preview August 30, 2021 15:02 Inactive
Copy link
Member

@emmenko emmenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md Outdated

3. Build and run the application kit

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

README.md Outdated
> 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

README.md Outdated
Comment on lines 26 to 32
### Initial Installation

1. Clone this repo

```bash
$ git clone https://github.com/commercetools/merchant-center-application-kit.git
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md Outdated
Comment on lines 59 to 64
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`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

@jmcreasman jmcreasman Sep 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screen Shot 2021-09-21 at 3 00 10 PM

@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?

README.md Outdated
Comment on lines 67 to 84
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}',
},
],
},
],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screen Shot 2021-09-21 at 2 44 09 PM

@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
@vercel vercel bot temporarily deployed to Preview September 21, 2021 19:20 Inactive
@vercel vercel bot temporarily deployed to Preview September 21, 2021 19:27 Inactive
@ByronDWall ByronDWall force-pushed the update-readme-developing-application-kit-bundles-docs branch from 9c0fac1 to 7fef0fa Compare September 21, 2021 19:33
@emmenko
Copy link
Member

emmenko commented Sep 22, 2021

@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
Copy link
Contributor Author

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

@emmenko emmenko marked this pull request as draft December 1, 2021 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants