mcclowes-react-sample-project

This project includes:

• Useful dependencies
• Reasonable project structure
• Examples of dumb components (Dumb) and smart, controlled components (Smart)
• Primitives with useful simple components
• Simple CircleCI configuration

Demo

Try it here: https://mcclowes-react-sample-project.now.sh/

Setting up the project

Install dependencies & check they work:

brew install git-lfs circleci && circleci config validate

Install NPM dependencies:

npm install

Running the project

You can run the project with the following command:

npm run start

Tests

You can run the project's test suite with the following command:

npm run test

Or, for watch mode:

npm run test:watch

Primitives

This repo comes equipped with a few simple customisable components, in the Primitives directory. You can delete all/as many as you wish, but they are included as they offer a more customisable and flexible alternative to npm packages.

Storybook

These Primitives components can be viewed by running:

npm run storybook

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome!

License