Components
Reusable React components used by HospitalRun
Overview
HospitalRun Components is a robust library designed for building the frontend of the HospitalRun application using reusable React components. This project aims to streamline the collaboration between designers and developers, making it easier for teams to work together effectively. The library encompasses various elements such as text inputs, labels, and more, providing a cohesive set of tools for frontend development.
The repository encourages contributions from the community, offering clear guidelines for how to get involved. With an emphasis on modern development practices, including one-click setup for contributions and structured commit guidelines, HospitalRun Components is positioned to facilitate collaboration and efficiency in software development.
Features
-
Reusable Components: A collection of React components tailored for the HospitalRun frontend, promoting code reuse and modular design.
-
Collaborative Development: Designed for easy collaboration between designers and developers, fostering a productive development environment.
-
Easy Installation: Installation is straightforward with commands for
npmusers, and additionally supports optional components likenode-sassfor SCSS file imports. -
Live Reloading with Storybook: Integrated support for Storybook allows developers to test and view components live, enhancing the development workflow.
-
Conventional Commits: Utilizes Conventional Commits for consistent versioning and documentation, ensuring clarity in project history and updates.
-
One-Click Setup: Offers a GitHub Codespace setup, enabling users to quickly get a fully functional development environment with all dependencies pre-installed.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- Bootstrap
Bootstrap is the most popular CSS Framework for developing responsive and mobile-first websites.
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Storybook
Storybook is a tool for developing and testing UI components in isolation. It provides a sandbox environment where you can experiment with different props and states to see how your component responds.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
