|
1 | | -# Cafedential (A cupping mobile app) |
2 | | -- This is an flutter cupping note app which could calculate the score of a cup of coffee and store it with some notes in firebase |
3 | | - |
4 | | -#### Icon and splash screen |
5 | | - |
6 | | - |
7 | | -### Authentication Screens |
8 | | - |
9 | | -- Regular |
10 | | - |
11 | | -| Welcome Screen | Login Screen |Register Screen | |
12 | | -| ------------------------------------ | -------------------------------------| ---------------------------------- | |
13 | | -|  |  || |
14 | | - |
15 | | -- Error Detection |
16 | | - |
17 | | -| Login Screen | Register Screen | |
18 | | -| ----------------------------------------- | ------------------------------------ | |
19 | | -|  |  | |
20 | | - |
21 | | - |
22 | | - |
23 | | -### Main Pages and Add Data Screen (Create) |
24 | | - |
25 | | -- Regular |
26 | | - |
27 | | -| Home Page | Add Data Screen 1 | Add Data Screen 2 | |
28 | | -| ------------------------------------ | ----------------------------------- |------------------------------------ | |
29 | | -|  | | | |
30 | | - |
31 | | - |
32 | | -### Then Home Page will show up the note you just added (Read) |
33 | | -|After passing valid value and press 'SAVE'...| |
34 | | -|---------------------------------------------| |
35 | | -| | |
36 | | - |
37 | | - |
38 | | - |
39 | | -- Error detection (Add Data Screen) |
40 | | - |
41 | | -| |  |  | |
42 | | -| ----------------------------------- | ------------------------------------ | ------------------------------------ | |
43 | | -| |  |  | |
44 | | - |
45 | | - |
46 | | - |
47 | | -#### Card Screen |
48 | | - |
49 | | -| | | | |
50 | | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | |
51 | | -| | | | |
52 | | - |
53 | | - |
54 | | -#### Edit Page (Update) |
55 | | - |
56 | | -- Regular |
57 | | - |
58 | | -| Edit Page 1 | Edit Page 2 | After passing valid value and press 'SAVE'...| |
59 | | -| ---------------------------------- | ---------------------------------- | -------------------------------------------- | |
60 | | -|||  | |
61 | | - |
62 | | - |
63 | | -- Error detection |
64 | | - |
65 | | -| Error Screen 1 | Error Screen 2 | Error Screen 3 | |
66 | | -| ----------------------------------- | ----------------------------------- | ---------------------------------- | |
67 | | -| | || |
68 | | - |
69 | | - |
70 | | -### Card Screen (After editing) |
71 | | - |
72 | | - |
73 | | -|  |  |  | |
74 | | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | |
75 | | -|  |  | | |
76 | | - |
77 | | - |
78 | | - |
79 | | -### Delete Dialog (Delete) |
80 | | -| Long Press the card you want to delete in the Home Page| Result | |
81 | | -| ------------------------------------------------------ | ----------------------------------- | |
82 | | -|  | | |
83 | | - |
84 | | - |
| 1 | +# Cafedential |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <img src="https://img.shields.io/badge/firebase-ffca28?style=for-the-badge&logo=firebase&logoColor=black" alt="Firebase Badge" /> |
| 7 | + <img src="https://img.shields.io/github/license/whiteSHADOW1234/CafedentialApp?label=license&style=for-the-badge" alt="License Badge" /> |
| 8 | + <img src="https://img.shields.io/badge/FLUTTER->=3.3.0-blue?style=for-the-badge" alt="Flutter Badge" /> |
| 9 | + <img src="https://img.shields.io/badge/DART->=2.18.0<3.0.0-orange?style=for-the-badge" alt="Dart Badge" /> |
| 10 | + <img src="https://img.shields.io/badge/PRs-welcome-black?style=for-the-badge" alt="PRs Welcome Badge" /> |
| 11 | +</p> |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +## Features |
| 18 | + |
| 19 | +- **Custom Icon & Splash Screen**: The app features a custom icon and splash screen, providing a welcoming first impression. |
| 20 | + |
| 21 | +- **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. |
| 22 | + |
| 23 | +- **Error Detection**: Every input field in the app includes error handling to guide users in case of incorrect or missing data. |
| 24 | + |
| 25 | +### Main Functionality |
| 26 | + |
| 27 | +1. **Coffee Notes Panel**: |
| 28 | + - **Main Page**: Displays a panel with cards for each coffee note, showing the coffee name, total score, final score, and notes. |
| 29 | + - **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. |
| 30 | + - **Automatic Scoring**: Scores are calculated automatically based on the input values, providing immediate feedback on each coffee. |
| 31 | + |
| 32 | +2. **Detailed View & Edit Mode**: |
| 33 | + - **View Mode**: Tap on a coffee card to view the details of the scoring notes. |
| 34 | + - **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. |
| 35 | + |
| 36 | +3. **Delete Notes**: |
| 37 | + - **Long-Press**: Long-press a card on the main page to open a confirmation dialog for deleting the note. |
| 38 | + - **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. |
| 39 | + |
| 40 | +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. |
| 41 | + |
| 42 | +## Screens |
| 43 | + |
| 44 | +1. **Splash Screen**: Displays the app’s icon as it loads. |
| 45 | + |
| 46 | +  |
| 47 | +2. **Authentication Screen**: Provides options for logging in or registering. If a new account is created, the app remembers it for automatic sign-in. |
| 48 | + | Welcome Screen | Login Screen | Register Screen | |
| 49 | + | ------------------------------------ | ------------------------------------ | ------------------------------------ | |
| 50 | + |  |  |  | |
| 51 | +3. **Main Panel**: Lists coffee notes with scoring details. The floating button provides quick access to add a new note. |
| 52 | + | Home Page | Home Page with cards (notes) | |
| 53 | + | ------------------------------------ | ------------------------------------ | |
| 54 | + |  |  | |
| 55 | +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. |
| 56 | + | Add Data Screen 1 | Add Data Screen 2 | |
| 57 | + | ------------------------------------ | ------------------------------------ | |
| 58 | + |  |  | |
| 59 | +5. **Note Detail & Edit Mode**: Provides detailed view and editing options for each coffee note. |
| 60 | + | Noted Detail | Edit Mode | |
| 61 | + | ------------------------------------ | ------------------------------------ | |
| 62 | + |  |  | |
| 63 | + |
| 64 | +## Getting Started |
| 65 | + |
| 66 | +### Prerequisites |
| 67 | +- Install Flutter SDK |
| 68 | +- Configure Firebase (or other backend) for authentication and storage |
| 69 | + |
| 70 | +### Installation |
| 71 | +1. Clone this repository: |
| 72 | + ```bash |
| 73 | + git clone https://github.com/whiteSHADOW1234/CafedentialApp.git |
| 74 | + ``` |
| 75 | +2. Navigate to the project directory: |
| 76 | + ```bash |
| 77 | + cd CafedentialApp |
| 78 | + ``` |
| 79 | +3. Run the app: |
| 80 | + ```bash |
| 81 | + flutter run |
| 82 | + ``` |
| 83 | + |
| 84 | +### Usage |
| 85 | +1. Open the app and register or log in. |
| 86 | +2. From the main page, tap the floating button to add a new coffee note. |
| 87 | +3. Fill in each attribute, and save the form to add a new note. |
| 88 | +4. Tap on any note to view, edit, or delete as needed. |
| 89 | + |
| 90 | +## Contributing |
| 91 | + |
| 92 | +Contributions are welcome! To contribute: |
| 93 | +1. Fork the repository. |
| 94 | +2. Create a new branch for your feature: |
| 95 | + ```bash |
| 96 | + git checkout -b feature-name |
| 97 | + ``` |
| 98 | +3. Make your changes and test thoroughly. |
| 99 | +4. Submit a pull request. |
| 100 | + |
| 101 | +## License |
| 102 | + |
| 103 | +This project is licensed under the MIT License. |
0 commit comments