@vtex/create-raccoon-app

This is a project bootstrapper for Raccoon projects.

Usage

# use the package manager of your choice
npx @vtex/create-raccoon-app
pnpm dlx @vtex/create-raccoon-app
yarn create @vtex/create-raccoon-app

Development

Install the dependencies, as usual:

pnpm i

And once you've made changes to the code, you can test them by running:

pnpm dev

Finally, make sure that you can spin up the bootstrapped project and that it works as expected!

To streamline testing, you can run the script below to create a new project, build it and spin it up on a VTEX workspace:

. test.sh

How does it integrate with DK Portal?

When used in the context of DK Portal, this package is called by the dk-create-base-repo CLI, following this project creation flow:

flowchart LR
 subgraph s1["DK Portal"]
        n3r["Backstage Scaffolder"]
        n5["Backstage Software Catalog"]
  end
    n1["create-raccoon-app"] --> n3["dk-create-base-repo"] & n5
    n3 --> n6["Raccoon Application template"]
    n3r --> n1
    n7(("Dev")) --> n3r