This CLI tool allows you to easily install and setup react-web, react-mobile and react-web-contentful. Check their repositories for more information.
npx create-react-prime@latest
cd <project name>
npm startor
npm init react-prime@latest
cd <project name>
npm startPassing arguments to the CLI is optional! The CLI will prompt questions for any missing required arguments. The order they are passed determines what they are used for.
| # | Argument name | Value | Default | Description |
|---|---|---|---|---|
| 1 | Project Name | Any text (no spaces) | Boilerplate name | The name of the project. No spaces allowed. Follows the directory naming rules of your current OS. This name will be applied to the installation directory, the package.json and depending on the boilerplate, can be applied to other files or directories as well. |
Passing options to the CLI is optional! The CLI will prompt questions for any missing required options.
| Option | Value | Default | Description |
|---|---|---|---|
| -b, --boilerplate | - | - | Start installation process for boilerplates |
| -m, --modules | - | - | Start installation process for modules |
| -c, --components | - | - | Start installation process for components |
| -d, --debug | - | false | Enable additional logging |
Make sure to read further before you start developing on the Create React Prime CLI tool!
The internals are located in the lib folder. This folder acts as an internal NPM package that can be referenced with @crp anywhere in this project. Make sure to discuss with the team beforehand if you want to add changes to the internal code.
Modules are located in the src folder. Here you can find the logic for every installation process that this CLI tool has to offer. It's not necessary to request for changes in this section of the codebase, but it's always good to discuss your plans with the team beforehand.
Make sure to familiarize yourself with the code style and folder/file structure before you start writing code!
You should always test a new Create React Prime flow on npx before making a merge request. Here is a step-by-step guide how to do that:
- Push your feature branch to GitHub
- this is important! Create React Prime will need to download this branch
- Set your current branch to the feature branch you want to test
- Check what the latest beta version is
- Update the version in
prime-monorepo/packages/create-react-prime/package.jsonto some version higher than the current + the tag! Also, Make sure to still follow semver!
- If it's a non-breaking change or bugfix: increase the last number;
- if it's a breaking change or new feature: increase the second number.
For example: v4.5.8 -> v4.5.9-beta.1
❗️ Do not push these changes to package.json to git!
- Run this script in the
prime-monorepo/packages/create-react-primefolder:
npm publish --tag beta
To use this version, run: npx create-react-prime@beta. Create React Prime will now use the branch that it was published from.
You can push multiple beta versions of the same release. Simply change -beta.1 to -beta.2 in package.json and run npm publish --tag beta again. You can use this new version by running npx create-react-prime@beta again (it can take a few seconds for this version to be ready on npx)
You can use other tags than beta if you want. This can be useful for debugging purposes where you don't want to spam the beta tag with many versions. To do that, simply replace beta in the step-by-step guide with the tag of your choice. Examples would be: alpha, dev, next, canary.