firefuel

Creates a Collection, Model Stub and optional Repository for the firefuel library.

Getting Started 🚀

Prerequisites

• Ensure the mason_cli is installed globally by running flutter pub global activate mason_cli in your Terminal.
• Run mason init inside of your Flutter app root directory.
• Run mason add firefuel

Using the package

Run mason make firefuel and follow the prompts!

Prompt: Collection name?

The name of a Firebase Cloud Firestore Collection (plural form)

Ex. Provide Users if you'd like to perform generation for your Users collection.

Prompt: Document name? Commonly the singular form of your Collection name.

The name of a Firebase Cloud Firestore Document (singular form)

Ex. A Users collection would contain User documents.

Prompt: Would you like to generate a Repository?

Whether to create a Repository class to contain your data layer business logic.

i.e. persist data both locally and remote, create a readable name for multiple collection access, etc.

For more information, see the docs

Mason Resources 🧱

This is a starting point for a new brick. A few resources to get you started if this is your first brick template:

• Official Mason Documentation
• Code generation with Mason Blog
• Very Good Livestream: Felix Angelov Demos Mason

Setup 🧑‍💻

Ensure you have the mason_cli installed.

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

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add firefuel

# Install globally
mason add -g firefuel

Usage 🚀

mason make firefuel

Variables ✨

i.e. persist data both locally and remote, create a readable name for multiple collection access, etc. | true | boolean

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.41 <0.1.0"

0.1.1

fix: template filenames

• Note: now using brick_oven package to generate templates for Mason

0.1.0

feat: initial release Asks for collection_name, document_name and whether to genereate a Repository.

Copyright 2023 Jonah Walker

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.