Skip to content

irangareddy/roomie_tasks

Roomie Tasks

coverage style: very good analysis License: MIT

Roomie Tasks is a Flutter application for managing shared tasks among roommates.

Roomie Tasks Banner

Getting Started 🚀

Prerequisites

  • Flutter SDK (version 3.5.3 or later)
  • Dart SDK (version 3.5.3 or later)
  • Git
  • Task (optional, for running predefined tasks)

Setup

  1. Clone the repository:

    git clone https://github.com/yourusername/roomie_tasks.git
    cd roomie_tasks
  2. Install dependencies:

    flutter pub get
  3. Set up Git hooks:

    git config core.hooksPath .git_hooks
    chmod +x .git_hooks/pre-commit
    chmod +x .git_hooks/commit-msg
  4. To run the app refer Development

Development

This project contains 3 flavors:

  • development
  • staging
  • production

To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands:

# Development
$ flutter run --flavor development --target lib/main_development.dart

# Staging
$ flutter run --flavor staging --target lib/main_staging.dart

# Production
$ flutter run --flavor production --target lib/main_production.dart

Using Task

If you have Task installed, you can use the following commands:

# List all available tasks
$ task

# Install dependencies
$ task get

# Format code
$ task format

# Analyze code
$ task analyze

# Run tests
$ task test

# Generate coverage report
$ task coverage

# Run development flavor
$ task dev

# Run staging flavor
$ task staging

# Run production flavor
$ task production

# Build APK (Production)
$ task build:apk

# Build App Bundle (Production)
$ task build:appbundle

# Build IPA (Production)
$ task build:ipa

Running Tests 🧪

To run all unit and widget tests use the following command:

# Testing
$ flutter test --coverage --test-randomize-ordering-seed random

To view the generated coverage report you can use lcov.

# Generate Coverage Report
$ genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
$ open coverage/index.html

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages