An experimental Gutenberg block editor for native iOS and Android apps relying upon web technologies.
In order to build GutenbergKit, the following tools must be installed on your development machine:
- Node.js - Required for building the web app; recommend using Node Version Manager.
- Xcode - Required if building iOS demo app.
- Android Studio - Required if building Android demo app.
Install the GutenbergKit dependencies and start the development server by running the following command in your terminal:
make dev-serverOnce finished, the web app can now be accessed in your browser by visiting the URL logged in your terminal. However, it is recommended to use a native host app for testing the changes made to the editor for a more realistic experience. A demo app is included in the GutenbergKit package, along with instructions on how to use it below.
This demo app is useful for quickly testing changes made to the editor. By default, the demo app uses a production build of the web app bundled with the GutenbergKit package—i.e., the output of the project's make build command. During development, however, it is more useful to run the web app with a server and provide the server URL as an environment variable for the demo app, so that changes are displayed in the app immediately.
- Start the development server by running
make dev-server. - Launch Xcode and open the
ios/Demo-iOS/Gutenberg.xcodeprojproject. - Select the
Gutenbergtarget. - Navigate to Product → Scheme → Edit Scheme.
- Add an environment variable named
GUTENBERG_EDITOR_URLwith the URL of the development server. - Run the app.
Example Xcode environment variable
- Start the development server by running
make dev-server. - Launch Android Studio and open the
androidproject. - Modify the
android/local.propertiesfile to include an environment variable namedGUTENBERG_EDITOR_URLwith the URL of the development server. - Run the app.
Example Android local.properties
GUTENBERG_EDITOR_URL=http://<YOUR_LOCAL_IP>:5173/
See the architecture overview for additional details regarding project organization and development tips.
Important, high-level test cases are documented for manual testing guidance. Additionally, automated tests are included in the project to ensure code quality and functionality.
To run the JavaScript tests, run the following command in your terminal:
make test-jsTo run the Swift tests, run the following command in your terminal:
make test-swiftTo run the Android tests, run the following command in your terminal:
make test-androidTo build GutenbergKit for production run the following command in your terminal:
make buildOnce finished, the Swift and Kotlin packages are ready to publish. Consuming iOS or Android host apps can then include the GutenbergKit package as a dependency.
See the release documentation for more information.