Merge pull request #1276 from crowdbotics/develop

Author: crowdbotics-apps

.circleci/config.yml

@@ -21,7 +21,7 @@ jobs:
           command: pwd && mkdir -p ~/build/demo
       - run:
           name: Create Demo App
-          command: yarn run demo
+          command: npx --yes crowdbotics demo --skip-login-check
       - persist_to_workspace:
           root: ~/build
           paths:

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Based on [Common Changelog](https://common-changelog.org/).
 
+## 2.5.0 - 2025-05-19
+
+### Added
+
+Removed CLI. Users should use https://github.com/crowdbotics/cli instead.
+
 ## 2.4.0 - 2023-12-21
 
 ### Added

Pipfile

@@ -26,15 +26,7 @@
 
 ## Requirements for contributing
 
-The following must be available in your system:
-
-- [node](https://nodejs.org/en)
-- [yarn](https://yarnpkg.com/)
-- [python](https://www.python.org/)
-- [pipenv](https://pypi.org/project/pipenv/)
-- [urllib3](https://urllib3.readthedocs.io/en/stable/) without this the project will not run in ```macOS``` environments
-
-Node `v18.16.0` (LTS) recommended.
+To begin contributing, install the [Crowdbotics CLI](https://www.npmjs.com/package/crowdbotics) and it's system requirements to your environment. Please see the [Crowdbotics documentation](https://docs.crowdbotics.com/docs/set-up-your-dev-env) for detailed instructions on how to setup your environment.
 
 ## Getting started
 
@@ -44,36 +36,32 @@ Install node modules:
 yarn install
 ```
 
-Install python packages:
+Also install the CLI:
 
 ```sh
-pipenv install
+npm install -g crowdbotics
 ```
 
 Spin a demo app using the customized React Native template:
 
 ```sh
-yarn run demo
+npx crowdbotics demo
 ```
 
 Install modules to your demo app:
 
 ```sh
-yarn run add react-native-app-menu
+npx crowdbotics add react-native-app-menu
 ```
 
 Create new modules and test/validate your work locally before submitting a PR:
 
 ```sh
-yarn run parse
-```
-
-Install modules globally to your system:
-```sh
-npm install -g cb
+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
@@ -82,14 +70,12 @@ 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`).
+- `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:
 
-- `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`).
+- `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](https://docs.crowdbotics.com/authoring-modules).