https://github.com/mcclowes/mcclowes-react-sample-project

Quickly spin up a fully kitted-out React project with this template
https://github.com/mcclowes/mcclowes-react-sample-project

boilerplate create-react-app project react sample

Last synced: about 1 month ago
JSON representation

Quickly spin up a fully kitted-out React project with this template

• Host: GitHub
• URL: https://github.com/mcclowes/mcclowes-react-sample-project
• Owner: mcclowes
• License: mit
• Created: 2019-10-10T22:05:05.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T08:46:35.000Z (almost 2 years ago)
• Last Synced: 2024-12-06T22:03:07.203Z (about 2 months ago)
• Topics: boilerplate, create-react-app, project, react, sample
• Language: JavaScript
• Homepage: https://mcclowes-react-sample-project.now.sh/
• Size: 7.14 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 53
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# mcclowes-react-sample-project

[![CircleCI](https://circleci.com/gh/mcclowes/mcclowes-react-sample-project.svg?style=svg)](https://circleci.com/gh/mcclowes/mcclowes-react-sample-project)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmcclowes%2Fmcclowes-react-sample-project.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmcclowes%2Fmcclowes-react-sample-project?ref=badge_shield)

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

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmcclowes%2Fmcclowes-react-sample-project.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fmcclowes%2Fmcclowes-react-sample-project?ref=badge_large)