create-carbon-app

create-carbon-app

Quickly create a ready-for-dev application that uses React & Carbon - inspired by create-react-app.

Get Started

npx create-carbon-app my-app
cd my-app
npm start

npx comes with npm v5.2+

Further Usage

Commands

There are a number of commands set up to use out of the box:

• npm start - This will boot the app using Webpack for development.
• npm test - This will boot Jest for running tests in watch mode (we also recommend you install NiM which will automatically open Chrome for you).
• npm run test:windows - Same as above, but for Windows environments.
• npm run build - This will compile assets ready for production (this defaults to the ./assets directory).
• npm run build:windows - Same as above, but for Windows environments.
• npm run ci - This will run a combination of lint and Jest, perfect for continuous integration.
• npm run jest - This will run Jest without any of the default options (without watch mode or debugging enabled).
• npm run lint -- ./src - This runs linting over your code.

Config

Webpack

Webpack is preconfigured using configuration from Carbon Factory. You can override options in the webpack.config.js file, or create your own!

See Webpack for more information.

Jest

Jest is preconfigured using configuration from Carbon Factory. You can override options in the jest.config.js file, or create your own!

See Jest for more information.

Licence

create-carbon-app is licensed under the Apache-2.0 licence.

Copyright (c) 2018 Sage Group Plc. All rights reserved.