-
Notifications
You must be signed in to change notification settings - Fork 590
Update README.md #10
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.
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
base: main
Are you sure you want to change the base?
Update README.md #10
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,99 +1,85 @@ | ||||||||||||||||||||||||||||||||||||||
| # [Project Name] 🎯 | ||||||||||||||||||||||||||||||||||||||
| # BRIGHTFUTURE 🎯 | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Basic Details | ||||||||||||||||||||||||||||||||||||||
| ### Team Name: [Name] | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Basic Details | ||||||||||||||||||||||||||||||||||||||
| This is website based on donation.BrightFuture connects people with impactful causes, tackling issues like clothing, food, and resources. Through hope, empathy, and community, we empower lives and transform communities. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### Team Name: THRIES | ||||||||||||||||||||||||||||||||||||||
| ### Team Members | ||||||||||||||||||||||||||||||||||||||
| - Member 1: [Name] - [College] | ||||||||||||||||||||||||||||||||||||||
| - Member 2: [Name] - [College] | ||||||||||||||||||||||||||||||||||||||
| - Member 3: [Name] - [College] | ||||||||||||||||||||||||||||||||||||||
| - Member 1: Ardhra P- College Of Engineering Thalassery | ||||||||||||||||||||||||||||||||||||||
| - Member 2: Haneena Fathima- College Of Engineering Thalassery | ||||||||||||||||||||||||||||||||||||||
| - Member 3: Jalibha Jabin- College Of Engineering Thalassery | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### Hosted Project Link | ||||||||||||||||||||||||||||||||||||||
| [mention your project hosted project link here] | ||||||||||||||||||||||||||||||||||||||
| Hosted link - https://ardra-p.github.io/Brightfuture/ | ||||||||||||||||||||||||||||||||||||||
| Repo link - https://github.com/ardra-p/Brightfuture | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### Project Description | ||||||||||||||||||||||||||||||||||||||
| [2-3 lines about what your project does] | ||||||||||||||||||||||||||||||||||||||
| The project mainly focuses on making the donation easy among different communities. | ||||||||||||||||||||||||||||||||||||||
| This can be used by both donor and receiver equally. | ||||||||||||||||||||||||||||||||||||||
| This project empower the needy ones. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### The Problem statement | ||||||||||||||||||||||||||||||||||||||
| [What ridiculous problem are you solving?] | ||||||||||||||||||||||||||||||||||||||
| The problem faced by the people in the society for getting their needy things and also for those who want to donate to wide range of people who are in need of these things. | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### The Solution | ||||||||||||||||||||||||||||||||||||||
| [How are you solving it? Keep it fun!] | ||||||||||||||||||||||||||||||||||||||
| Our mission is to unite people with meaningful causes, tackling vital issues such as clothing, food, blood, financial support, and e-devices, driven by hope, empathy, and community. | ||||||||||||||||||||||||||||||||||||||
| our is to unite people around meaningful causes that address critical societal issues all driven by hope, empathy, and community. | ||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+26
to
+27
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Remove duplicate mission statement. The mission statement is repeated twice with slightly different wording. Keep only one version for clarity. Our mission is to unite people with meaningful causes, tackling vital issues such as clothing, food, blood, financial support, and e-devices, driven by hope, empathy, and community.
-our is to unite people around meaningful causes that address critical societal issues all driven by hope, empathy, and community. 📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Technical Details | ||||||||||||||||||||||||||||||||||||||
| ### Technologies/Components Used | ||||||||||||||||||||||||||||||||||||||
| For Software: | ||||||||||||||||||||||||||||||||||||||
| - [Languages used] | ||||||||||||||||||||||||||||||||||||||
| - [Frameworks used] | ||||||||||||||||||||||||||||||||||||||
| - [Libraries used] | ||||||||||||||||||||||||||||||||||||||
| - [Tools used] | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| For Hardware: | ||||||||||||||||||||||||||||||||||||||
| - [List main components] | ||||||||||||||||||||||||||||||||||||||
| - [List specifications] | ||||||||||||||||||||||||||||||||||||||
| - [List tools required] | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### Implementation | ||||||||||||||||||||||||||||||||||||||
| dd caption e### Technologies/Components Used | ||||||||||||||||||||||||||||||||||||||
| For Software: | ||||||||||||||||||||||||||||||||||||||
| # Installation | ||||||||||||||||||||||||||||||||||||||
| [commands] | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Run | ||||||||||||||||||||||||||||||||||||||
| [commands] | ||||||||||||||||||||||||||||||||||||||
| - html,css,java script,PHP | ||||||||||||||||||||||||||||||||||||||
| - VScode,Github,Discord | ||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+30
to
+33
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Fix formatting and capitalization in technical details. The technology list needs proper formatting and correct capitalization of technology names. -dd caption e### Technologies/Components Used
-For Software:
-- html,css,java script,PHP
-- VScode,Github,Discord
+### Technologies/Components Used
+For Software:
+- HTML
+- CSS
+- JavaScript
+- PHP
+- Visual Studio Code
+- GitHub
+- Discord📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~32-~32: Did you mean “JavaScript” (= programming language)? (JAVA_SCRIPT) |
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### Project Documentation | ||||||||||||||||||||||||||||||||||||||
| For Software: | ||||||||||||||||||||||||||||||||||||||
| For Software:BRIGHTFUTURE | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Screenshots (Add at least 3) | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *Add caption explaining what this shows* | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *Add caption explaining what this shows* | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *Add caption explaining what this shows* | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Diagrams | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *Add caption explaining your workflow* | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| For Hardware: | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Schematic & Circuit | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *Add caption explaining connections* | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *Add caption explaining the schematic* | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Build Photos | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *List out all components shown* | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *Explain the build steps* | ||||||||||||||||||||||||||||||||||||||
| # Schematic & Circuit | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Build Photos | ||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+39
to
+71
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💡 Codebase verification Images are using temporary storage and need to be moved to repository assets The verification confirms that all images are using GitHub's temporary user-attachments storage, which is not suitable for permanent documentation. These URLs return 302 redirects and may become inaccessible. To fix:
🔗 Analysis chainVerify image accessibility. Please verify that all image URLs are publicly accessible. The current URLs use the
Run this script to verify image accessibility: 🏁 Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Check if images are accessible
for url in $(grep -o 'https://github.com/user-attachments/assets/[a-f0-9-]*' README.md); do
echo "Checking $url"
status=$(curl -s -o /dev/null -w "%{http_code}" $url)
echo "Status: $status"
done
Length of output: 8086 |
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||||||||||
| *Explain the final build* | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ### Project Demo | ||||||||||||||||||||||||||||||||||||||
| # Video | ||||||||||||||||||||||||||||||||||||||
| [Add your demo video link here] | ||||||||||||||||||||||||||||||||||||||
| *Explain what the video demonstrates* | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| # Additional Demos | ||||||||||||||||||||||||||||||||||||||
| [Add any extra demo materials/links] | ||||||||||||||||||||||||||||||||||||||
| Folder Link: https://drive.google.com/drive/folders/1956f6zvJ6qE31APt2EoMTrUMS8KtoWXg?usp=sharing | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| ## Team Contributions | ||||||||||||||||||||||||||||||||||||||
| - [Name 1]: [Specific contributions] | ||||||||||||||||||||||||||||||||||||||
| - [Name 2]: [Specific contributions] | ||||||||||||||||||||||||||||||||||||||
| - [Name 3]: [Specific contributions] | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| - Ardhra P:Home Page,WebSite,Contents And Images | ||||||||||||||||||||||||||||||||||||||
| - Haneena Fathima:Web Pages,Contents And Images | ||||||||||||||||||||||||||||||||||||||
| - Jalibha Jabin:Web Pages,Contents And Images | ||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||
| Made with ❤️ at TinkerHub | ||||||||||||||||||||||||||||||||||||||










There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Fix grammatical issues in the project description.
There are several grammatical issues that need to be addressed:
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: You might be missing the article “a” here.
Context: ...HTFUTURE 🎯 ## Basic Details This is website based on donation.BrightFuture connects...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~5-~5: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...Basic Details This is website based on donation.BrightFuture connects people with impac...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)