Codux Help Center
Browse our articles to find the answers you need
Project Prerequisites and Dependencies
Important!
Your project needs to have a
package.json file in the root directory of your project (or package if it's in a monorepo). This file is crucial as it describes your project and inventories its dependencies, such as required TypeScript and React versions. You can create this file by running npm init in your project directory and following the prompts. Without this file, your project won't be able to track its dependencies, which could lead to errors when trying to run or build your project.Important!
There also needs to be a
codux.config.json file with the newComponent key configured.When you create a new project through Codux, both a
package.json file and a codux.config.json file will be created for it. If you add a local project or a project from GitHub that wasn't created through Codux, you will need to add these files yourself.package.json
codux.config.json
@wixc3/react-board
To install the helper package in your project so that users won't see the prompt, run the following command from your project's root directory:
npm i @wixc3/react-board --save-dev
Or, if your project uses Yarn, and you'd prefer:
yarn add @wixc3/react-board --dev
Note:
Codux will also visually prompt users to update older versions of
@wixc3/react-board when they no longer meet the minimum requirements.For information on creating board files for your project, continue here.
Was this article helpful?
