Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 30 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@


### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: [Ajay Suseel] - [TKM COLLEGE OF ENGINEERING KOLLAM]
- Member 2: [Kishan P K] - [TKM COLLEGE OF ENGINEERING KOLLAM]
- Member 3: [Abhiram K Aravind] - [TKM COLLEGE OF ENGINEERING KOLLAM]

### Project Description
[2-3 lines about what your project does]
[A gamified TODO list that allows users to add tasks,monitor and complete them earn points and use those points to level up your pet pokemon]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix grammatical issues in the project description.

The project description needs better punctuation and capitalization:

-[A gamified TODO list that allows users to add tasks,monitor and complete them earn points and use those points to level up your pet pokemon]
+[A gamified TODO list that allows users to add tasks, monitor and complete them, earn points, and use those points to level up their pet Pokémon]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
[A gamified TODO list that allows users to add tasks,monitor and complete them earn points and use those points to level up your pet pokemon]
[A gamified TODO list that allows users to add tasks, monitor and complete them, earn points, and use those points to level up their pet Pokémon]
🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Possible missing preposition found.
Context: ... to add tasks,monitor and complete them earn points and use those points to level up...

(AI_HYDRA_LEO_MISSING_TO)

[grammar] ~16-~16: The name of this game or TV show is spelled with an accent.
Context: ...d use those points to level up your pet pokemon] ### The Problem (that doesn't exist) ...

(POKEMON)


### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
[People find it difficult to keep track of day to day tasks.]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider enhancing the problem and solution statements.

While the statements are clear, they could be more engaging and aligned with the project's gamified nature:

-[People find it difficult to keep track of day to day tasks.]
+[Traditional TODO lists are boring and don't motivate users to complete their daily tasks.]

-[A gamified version of TODO list that allows users to not only add tasks but also complete it purely by marking it completed(no proof required)]
+[A fun, Pokémon-themed TODO list that motivates users by rewarding task completion with points to level up their virtual pet]

Also applies to: 22-22


### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
[A gamified version of TODO list that allows users to not only add tasks but also complete it purely by marking it completed(no proof required)]

## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Dart]
- [Firebase]
- [Libraries used]
- [Tools used]

Expand All @@ -37,23 +37,31 @@ For Hardware:
### Implementation
For Software:
# Installation
[commands]
git clone repo_name
cd GTODO
flutter pub get
npm install -g firebase-tools
flutterfire configure

# Run
[commands]
[flutter run]

### Project Documentation
For Software:

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
![Screenshot 2024-10-26 071856](https://github.com/user-attachments/assets/38e7910b-64c4-4c6b-ace5-0cdb86b11765)

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
caption:login page

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
![Screenshot 2024-10-26 071932](https://github.com/user-attachments/assets/8d52c3e7-34bb-413a-bb2a-c4b83342146d)

caption : Home page


![Screenshot 2024-10-26 072031](https://github.com/user-attachments/assets/e21be6a4-aa97-4243-9aa7-2f208774da76)

caption: Task management

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
Expand All @@ -80,16 +88,17 @@ For Hardware:

### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*
(https://drive.google.com/file/d/1ehf5xPWyTl6X9_tp8UWmQnLCxGL4h89u/view?usp=drive_link)

logging in ,viewing your avatar,leveling up with points and managing tasks
Comment on lines +91 to +93
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Format the demo link properly.

The demo link needs proper Markdown formatting:

-(https://drive.google.com/file/d/1ehf5xPWyTl6X9_tp8UWmQnLCxGL4h89u/view?usp=drive_link)
+[Watch Demo](https://drive.google.com/file/d/1ehf5xPWyTl6X9_tp8UWmQnLCxGL4h89u/view?usp=drive_link)

-logging in ,viewing your avatar,leveling up with points and managing tasks
+Demo features:
+- User authentication
+- Avatar customization
+- Level progression system
+- Task management interface
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(https://drive.google.com/file/d/1ehf5xPWyTl6X9_tp8UWmQnLCxGL4h89u/view?usp=drive_link)
logging in ,viewing your avatar,leveling up with points and managing tasks
[Watch Demo](https://drive.google.com/file/d/1ehf5xPWyTl6X9_tp8UWmQnLCxGL4h89u/view?usp=drive_link)
Demo features:
- User authentication
- Avatar customization
- Level progression system
- Task management interface
🧰 Tools
🪛 Markdownlint

91-91: null
Bare URL used

(MD034, no-bare-urls)


# Additional Demos
[Add any extra demo materials/links]

## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
- Ajay Suseel: Firebase
- Kishan P K: flutter frontend
- Abhiram K Aravind: flutter frontend

---
Made with ❤️ at TinkerHub Useless Projects
Expand Down