Skip to content

Latest commit

 

History

History
104 lines (65 loc) · 2.96 KB

README.md

File metadata and controls

104 lines (65 loc) · 2.96 KB

headerIMG



This read me is for Developing on this repo. If you are looking for documentation on a package or a widget please go here

📂 Basic Folder Structure

|-- apps
    |
    |-- native-widgets
    |    |- * Native Widgets
    |
    |-- utils
    |   |- * Helper Functions/Published Packages
    |
    |-- web-widgets
    |   |- * Web Widgets

💅 Initial Setup

After cloning the repo, in the Root file run yarn - That will install the all the dependencies

The repos uses Turborepo under the hood, the migration from lerna to Terborepo is still WIP

⛑️ Helper Scripts

Remove node_modules from packages - yarn clean:packages

Remove ALL node_modules Hoisted and non Hoisted - yarn clean:all mac and linux only

🐝 Known Errors

🐛 Error: "A Local Dependency I installed is giving an type error "No Type Declaration found""

👍🏽 Fix: This might be an VSCode error. Close and re-open

➕ Adding an existing Repo to the Mono Repo

Basic command Structure

git subtree add --prefix=packages/[PATH/PROJECT_NAME] [REPO URL] [BRANCH NAME]


# Example:

git subtree add --prefix=packages/web-widgets/dad  git://github.com/ahwelgemoed/drag-and-drop-mendix-widget.git main

This will Create a folder called dad in packages/web-widgets. It will merge git history from ahwelgemoed/drag-and-drop-mendix-widget at the current main branch

📦 Versioning and Release your Package

TBA

💻 Versioning and Release your Widget

This packages uses a Github action to build and maintain versioning with lerna version.

For details on the Action see here

✨ Contributors


Justin Roy Tamaela
🤔

✨ Past Contributors


Jelte Lagendijk
🤔💻⚠️📖💡🚧
Arno Welgemoed
🤔💻⚠️📖💡🚧

Want/Need

  • Licence
  • First Pull - Docs
  • Look into Build Script and release (semi done!)