https://github.com/sage/create-carbon-app
Quickly create a ready-for-dev application that uses React & Carbon.
https://github.com/sage/create-carbon-app
Last synced: about 1 year ago
JSON representation
Quickly create a ready-for-dev application that uses React & Carbon.
- Host: GitHub
- URL: https://github.com/sage/create-carbon-app
- Owner: Sage
- License: apache-2.0
- Archived: true
- Created: 2018-07-12T11:01:59.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-09-12T08:24:49.000Z (almost 7 years ago)
- Last Synced: 2025-03-24T01:35:10.674Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 154 KB
- Stars: 7
- Watchers: 27
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-carbon-app
Quickly create a ready-for-dev application that uses [React](https://reactjs.org/) & [Carbon](https://carbon.sage.com/) - inspired by [create-react-app](https://github.com/facebook/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](https://chrome.google.com/webstore/detail/nodejs-v8-inspector-manag/gnhhdgbaldcilmgcpfddgdbkhjohddkj?hl=en) 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](https://github.com/sage/carbon-factory). You can override options in the `webpack.config.js` file, or create your own!
See [Webpack](https://webpack.js.org/) for more information.
#### Jest
Jest is preconfigured using configuration from [Carbon Factory](https://github.com/sage/carbon-factory). You can override options in the `jest.config.js` file, or create your own!
See [Jest](https://jestjs.io/) for more information.
## Licence
create-carbon-app is licensed under the [Apache-2.0 licence](https://github.com/Sage/create-carbon-app/blob/master/LICENSE).
Copyright (c) 2018 Sage Group Plc. All rights reserved.