Thank you for your interest in developing ChativeWidget! Below is a detailed guide on the development process, packaging, and testing the module.
-
Clone the repository to your local machine:
git clone https://github.com/botstar/@chative.io/react-native-widget.git cd @chative.io/react-native-widget -
Install dependencies:
yarn install
-
Create a new branch for your feature or bug fix:
git checkout -b feature/feature-name -
Make your changes in the source code.
-
Run lint and fix any issues:
yarn lint -
Commit your changes:
git commit -am "Add new feature: Brief description"
After you've completed your changes and want to test them:
-
Update the version in
package.jsonif necessary. -
Package the module:
yarn packThis will create a
.tgzfile in the root directory of the project.
-
Navigate to the examples directory:
cd examples -
Install the new version of the module and start the example app:
yarn livechatThis command will perform the following steps:
- Remove the current version of @chative.io/react-native-widget
- Clear the yarn cache
- Install the new version from the .tgz file
-
Run the example app with Expo:
- To run on iOS:
yarn ios - To run on Android:
yarn android - To run on web:
yarn web
- To run on iOS:
-
Thoroughly test to ensure everything works as expected across different platforms.
-
Push your branch to GitHub:
git push origin feature/feature-name -
Create a Pull Request on GitHub from your branch to the main branch (main or master).
-
Describe your changes in detail in the Pull Request description.
-
Wait for review and feedback from maintainers.
- Always test your changes on both iOS and Android before submitting a Pull Request.
- Update documentation (README.md, JSDoc, etc.) if you add or change any features.
- If you encounter any issues during development, don't hesitate to create an issue or ask in your Pull Request.
Thank you for contributing to ChativeWidget!