mobile_bricks

Ready to use (and of course, to custom) code templates for ZOT Mobile team.

Getting Started

🎯 Pub.dev

Install mason_cli from pub.dev

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

Initialize Mason

Go to the root folder of your mobile project and initialize Mason:

mason init

✨ Bricks List

Brick Name	Path to brick	Description
app_scaffolding	app_scaffolding	Scaffold a complete mobile app project.
new_feature	new_feature	Add a new feature with clean architecture
feature_applink	features/applink	Add applink setup to your project
feature_social_auth	features/social_auth	Add a social authentication integration
feature_product_cart	features/product_cart	Add simple product and shopping cart feature

📥 Download the bricks.

There are two ways to download the bricks, remotely and locally.

⛅️ Remotely From the Repo

Example: adding a brick to the list and installing.

mason add <brick_name> --git-url https://gitlab.zero-one-group.com/zo-group/software/mobile_bricks.git --git-path /path/to/brick

💾 Locally From the Cloned Repo

Getting the bricks from repositories can stuck for some reason, such as some security check issue. Alternatively, you can clone the repo and get it locally.

Example:

1. Clone the repo

git clone git@gitlab.zero-one-group.com:zo-group/software/mobile_bricks.git

2. Install the local brick.

mason add app_scaffolding --path path/to/your/cloned/repo/brick

Example:

mason add app_scaffolding --path ../../../mobile_bricks/app_scaffolding

🧱 Get the bricks

mason get

Use Cases

🚀 Project Initialization

Instead of having a useless default "counter-app" project, use brick app_scaffolding. Just go to the root of your mobile project and run this command.

1. Add the brick.

mason add app_scaffolding --path path/to/your/cloned/repo/app_scaffolding

2. Make it.

mason make app_scaffolding

This initializes the whole starter app setup.

Add Reusable Feature

Let's say you want to add an App link functionality. We have feature_applink.

1. Add the brick

mason add <brick_name> --git-url https://gitlab.zero-one-group.com/zo-group/software/mobile_bricks.git --git-path path/to/brick

2. Make it

mason make <brick_name>

Available features are place under feature folder.

Feature Creation

1. Add the brick

mason add new_feature --git-url https://gitlab.zero-one-group.com/zo-group/software/mobile_bricks.git --git-path new_feature        

2. Make it

mason make new_feature

📦 Contributing

Any contributions are welcomed. You can either file an issue, open a PR, or create a new impactful brick others can benefit from. If you're making significant changes or refactor to the existing bricks, please elaborate your take on it.