We know that there are a ton of react UI library projects to choose from. Our hope with this one is to provide an Aim to provide the nest generation of react components that you can use to bootstrap your next project, or as a reference for building a UIKit. Read on to get started!
- React
- Isolation
- Statically Typed
- TypeScript
- Styled Components
- React
- Validation
-
Clone the Repo
git clone https://github.com/Up-Group/react-controls
-
Install Dependencies From the root of the project directory, run
yarn
if you have yarn installed globally. --- or ---npm install
.
This project embraces styled-components as it's a fantastic way to style your React components.
Check the components directory for examples.
src/
│ ├── Input
│ │ ├── __tests__
│ │ │ ├── __mocks__
│ │ │ │ └── boxMocks.mock.ts
│ │ │ ├── __snapshots__
│ │ │ │ └── index.test.tsx.snap
│ │ │ └── index.test.tsx
│ │ ├── index.tsx
│ │ ├── styles.ts
│ │ └── types.ts
| | └── ...
├── index.ts
Next to come
Included is a test framework for all of your React testing needs. We are using Jest to run the test suite and generate snapshots, plus Enzyme for component introspection.
Tests should be collocated within the component they represent. Test files should be named index.test.tsx
and mocks must be named myMock.mock.ts
.
npm run setup:yarn
- Install the package dependencies via yarn
npm install
- Install dependencies (the ol' fashioned way)
npm run test
- Run the test suite
npm run test:watch
- Run the test suite in watch mode
npm run test:update
- Update the failing snapshot tests
See here for our contribution guide. We are on slack, please go [here for an invite] We'd love to hear from you!
See here for the license.
In progress