https://github.com/mcclowes/codat-experiment-sample-project

wip
https://github.com/mcclowes/codat-experiment-sample-project

Last synced: 9 months ago
JSON representation

wip

• Host: GitHub
• URL: https://github.com/mcclowes/codat-experiment-sample-project
• Owner: mcclowes
• License: mit
• Created: 2022-06-23T21:04:03.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-06-24T07:25:47.000Z (over 3 years ago)
• Last Synced: 2025-02-15T11:29:46.899Z (11 months ago)
• Language: JavaScript
• Homepage: codat-sample-project.vercel.app
• Size: 77.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• 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)