Skip to content

crowdbotics/modules

Repository files navigation

A library of Django & React Native modules.

Source Code linter Production Release

Contents

Requirements for contributing

To begin contributing, install the Crowdbotics CLI and it's system requirements to your environment. Please see the Crowdbotics documentation for detailed instructions on how to setup your environment.

Getting started

Install node modules:

yarn install

Also install the CLI:

npm install -g crowdbotics

Spin a demo app using the customized React Native template:

npx crowdbotics demo

Install modules to your demo app:

npx crowdbotics add react-native-app-menu

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

npx crowdbotics parse

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.
  • npx crowdbotics parse checks pass.
  • you can open your module in the demo app (npx crowdbotics demo, npx crowdbotics add <your-module-name-here>, cd demo; npx react-native-start).

When making changes to a module please make sure that:

  • npx crowdbotics parse checks pass.
  • you can open your module in the demo app (npx crowdbotics demo, npx crowdbotics 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.