Crowdbotics Modules

A library of Django & React Native modules.

Contents

• Modules library
• Changelog
• Documentation
• All commands

Requirements for contributing

The following must be available in your system:

• node
• yarn
• python
• pipenv
• urllib3 without this the project will not run in macOS environments

Node v18.16.0 (LTS) recommended.

Getting started

Install node modules:

yarn install

Install python packages:

pipenv install

Spin a demo app using the customized React Native template:

yarn run demo

Install modules to your demo app:

yarn run add react-native-app-menu

Create new modules and test/validate your work locally before submitting a PR:

yarn run parse

Install modules globally to your system:

npm install -g cb

macOS config

• make sure to have a compatible version of urllib3 with openssl. urllib3 v2.0 or higher is compatible with OpenSSL 1.1.1 or higher

Modules updates checklist

When adding a new module please make sure that:

• it includes a meta.json file in the module's root directory.
• it includes a preview.png image in the module's root directory.
• yarn run parse checks pass.
• you ran yarn run dist and added the changes.
• you can open your module in the demo app (yarn run demo, yarn run add <your-module-name-here>, cd demo; npx react-native-start).

When making changes to a module please make sure that:

• yarn run parse checks pass.
• you ran yarn run dist and added the changes.
• you can open your module in the demo app (yarn run demo, yarn run add <your-module-name-here>, cd demo; npx react-native-start).

Include as much documentation for your module as possible, and if you haven't seen it yet we created a style guide for Authoring Modules.