Skip to content

Rate your coffee like a pro and keep track of every brew! ☕

License

Notifications You must be signed in to change notification settings

whiteSHADOW1234/CafedentialApp

Repository files navigation

Cafedential

CafedentialApp

Firebase Badge License Badge Flutter Badge Dart Badge PRs Welcome Badge

This open-source Flutter app allows coffee enthusiasts and professionals to score their coffee based on the Specialty Coffee Association (SCA) Cupping Protocol. It’s designed to offer an intuitive experience for evaluating coffee attributes and storing detailed tasting notes.

Features

  • Custom Icon & Splash Screen: The app features a custom icon and splash screen, providing a welcoming first impression.

  • Authentication: Users are greeted with a welcome screen, where they can either log in or register a new account. After registering, users are automatically signed in every time they open the app.

  • Error Detection: Every input field in the app includes error handling to guide users in case of incorrect or missing data.

Main Functionality

  1. Coffee Notes Panel:

    • Main Page: Displays a panel with cards for each coffee note, showing the coffee name, total score, final score, and notes.
    • Add Coffee Note: Tap the floating button to go to the "Add Data" screen, where users can rate their coffee based on several aspects like temperature, grind size, brew time, and brew method.
    • Automatic Scoring: Scores are calculated automatically based on the input values, providing immediate feedback on each coffee.
  2. Detailed View & Edit Mode:

    • View Mode: Tap on a coffee card to view the details of the scoring notes.
    • Edit Mode: Users can press the "pen" icon at the top-right of the screen to enter edit mode. All fields are pre-populated with stored values for easy updating. Once edits are complete, users can save their changes to update the database.
  3. Delete Notes:

    • Long-Press: Long-press a card on the main page to open a confirmation dialog for deleting the note.
    • Delete Icon: Alternatively, tap a coffee card, enter the detailed view, and press the trash can icon at the top-right corner to delete the note.
  4. Friendly Hints: If there are no notes, the main page displays a friendly GIF and hints to encourage users to add their first note.

Screens

  1. Splash Screen: Displays the app’s icon as it loads.

    Group 68 (1)

  2. Authentication Screen: Provides options for logging in or registering. If a new account is created, the app remembers it for automatic sign-in.

    Welcome Screen Login Screen Register Screen
  3. Main Panel: Lists coffee notes with scoring details. The floating button provides quick access to add a new note.

    Home Page Home Page with cards (notes)
  4. Add Data Screen: Form-based screen to score coffee on various parameters. The “Save” button saves data and displays the note on the main panel.

    Add Data Screen 1 Add Data Screen 2
  5. Note Detail & Edit Mode: Provides detailed view and editing options for each coffee note.

    Noted Detail Edit Mode

Getting Started

Prerequisites

  • Install Flutter SDK
  • Configure Firebase (or other backend) for authentication and storage

Installation

  1. Clone this repository:
    git clone https://github.com/whiteSHADOW1234/CafedentialApp.git
  2. Navigate to the project directory:
    cd CafedentialApp
  3. Run the app:
    flutter run

Usage

  1. Open the app and register or log in.
  2. From the main page, tap the floating button to add a new coffee note.
  3. Fill in each attribute, and save the form to add a new note.
  4. Tap on any note to view, edit, or delete as needed.

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature:
    git checkout -b feature-name
  3. Make your changes and test thoroughly.
  4. Submit a pull request.

License

This project is licensed under the MIT License.