This project is designed to provide reusable components for React applications, aimed at streamlining development and maintaining a consistent UI across projects. The main objective is to offer a library of components that can be easily integrated into any React project for faster development and higher maintainability.
To install and set up the project, follow these steps:
-
Clone the repository:
git clone https://github.com/iranpsc/components-react.git cd components-react -
Install the necessary packages:
npm install
-
Configure the required environment files (if any).
-
Run the project using the following command:
npm run dev
To contribute to this project, follow these steps:
-
First, fork the repository and then create a separate branch for your changes:
git checkout -b feature-branch-name
-
Make your changes and commit them regularly with descriptive messages:
git commit -m "Brief description of the changes" -
Once your changes are complete, submit a pull request to have it reviewed by the development team.
When contributing, developers should follow these rules:
-
Separate branches for each feature: For every new feature or bug fix, create a separate branch with an appropriate name. For example:
git checkout -b feature/new-feature
-
Regular commits with descriptive messages: Make small, regular commits with clear explanations to make tracking changes easier. Use descriptive commit messages.
-
Submit pull requests for review: Before merging into the main (
mainormaster) branch, submit a pull request to have your changes reviewed by the team. -
Follow coding standards: All code must adhere to the project's coding standards. Use linting tools to ensure code quality.
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
Currently, two official plugins are available:
- @vitejs/plugin-react uses Babel for Fast Refresh
- @vitejs/plugin-react-swc uses SWC for Fast Refresh