@christfellowshipchurch/flat-ui-web

@christfellowshipchurch/flat-ui-web

About

This React DOM package is the Flat UI kit developed by Christ Fellowship Church. This UI Kit uses hard edges, solid colors, and no shadows to give a flat look to the overall design. Check out a directory for descriptions of each UI element and use cases for each of the elements.

Usage

This package uses a handful of other packages and technologies

• React Dom
• SASS
• Bootstrap 4
• Reactstrap - a React Bootstrap library
• FontAwesome - icon library

Make sure that when you set up your project using this package, you import the main style sheet into your package. It'll be inside of node_modules/@christfellowship/flat-ui-web/styles/css/styles.css.

QUICK TIP: This stylesheet includes compiled Bootstrap, so there's no need to import Bootstrap after importing this stylesheet unless you're wanting custom Bootstrap theming. We are working on getting this to be modularized to remove the global stylesheet dependency, so this is just a temporary solution for right now. Version 1 will be released with a fully modularized styling system.

Testing

Flat UI Web using jest snapshots for testing.

Running yarn test runs a test and outputs the result. When run at the root, it will run tests for the entire project. Running at a specific directory will run tests for that directory.

Running yarn test -u will update snapshots. Only do this if you are positive that snapshots need to be updated.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate. Commits without tests are not likely to be taken into consideration.

Authors and acknowledgment

Caleb Panza

License

MIT