-
Notifications
You must be signed in to change notification settings - Fork 290
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
Testing #9
base: main
Are you sure you want to change the base?
Testing #9
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,101 +1,112 @@ | ||||||
<img width="1280" alt="readme-banner" src="https://github.com/user-attachments/assets/35332e92-44cb-425b-9dff-27bcf1023c6c"> | ||||||
|
||||||
# [Project Name] 🎯 | ||||||
|
||||||
# AntiAlgo 🎯 | ||||||
|
||||||
## Basic Details | ||||||
### Team Name: [Name] | ||||||
|
||||||
### Team Name: AA | ||||||
|
||||||
### Team Members | ||||||
- Team Lead: [Name] - [College] | ||||||
- Member 2: [Name] - [College] | ||||||
- Member 3: [Name] - [College] | ||||||
|
||||||
- Member: Akshadha A - CUSAT | ||||||
|
||||||
### Project Description | ||||||
[2-3 lines about what your project does] | ||||||
|
||||||
The project, The Anti-Algorithm, is a reverse recommendation system that takes users’ favorite books, movies, or memes and suggests completely unrelated items. Instead of matching their tastes, the system recommends random, obscure things they’d never think to explore. | ||||||
|
||||||
### The Problem (that doesn't exist) | ||||||
[What ridiculous problem are you solving?] | ||||||
|
||||||
People are constantly trapped in their echo chambers, discovering content that aligns too closely with their tastes. How can someone truly expand their horizons if they’re only recommended things they actually like? | ||||||
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. Improve question phrasing The sentence could be rephrased for better clarity. -How can someone truly expand their horizons if they're only recommended things they actually like?
+What chance does someone have to truly expand their horizons if they're only recommended things they actually like? 📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~19-~19: Use ‘what’ rather than ‘how’ when forming a question with ‘like’. (HOW_LIKE) |
||||||
|
||||||
### The Solution (that nobody asked for) | ||||||
[How are you solving it? Keep it fun!] | ||||||
|
||||||
Our app deliberately mismatches users’ preferences, injecting a bit of randomness and surprise into their lives! | ||||||
[randomness at its finest] | ||||||
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. Remove placeholder text The text "[randomness at its finest]" appears to be a placeholder. Either expand this into a meaningful statement or remove it. -[randomness at its finest] 📝 Committable suggestion
Suggested change
|
||||||
|
||||||
## Technical Details | ||||||
|
||||||
### Technologies/Components Used | ||||||
|
||||||
For Software: | ||||||
- [Languages used] | ||||||
- [Frameworks used] | ||||||
- [Libraries used] | ||||||
- [Tools used] | ||||||
|
||||||
- Languages used : JavaScript, Python | ||||||
- Frameworks used : ReactJS [frontend], FastAPI [backend] | ||||||
- Libraries used : SQLAlchemy (for database ORM), SQLite (database) | ||||||
- Tools used : Uvicorn (for running FastAPI server), JSON or external APIs for random items | ||||||
|
||||||
For Hardware: | ||||||
|
||||||
- [List main components] | ||||||
- [List specifications] | ||||||
- [List tools required] | ||||||
Comment on lines
37
to
41
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 Remove hardware section from README.md Based on the repository content, this appears to be a pure software project with only a README.md file. The hardware sections with placeholders for circuits, schematics, and build photos are irrelevant as:
🔗 Analysis chainConsider removing hardware section Since this appears to be a software project (a recommendation system), the hardware section might not be relevant. Consider removing it unless there are specific hardware requirements. Let me check the actual content of README.md to understand the context better. Let me check if this is actually a hardware project by looking for any hardware-related code or configuration files. Let me check the main project structure and any technology-related files to confirm if this is purely a software project. 🏁 Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Check if there are any hardware-related files in the repository
rg -l "hardware|circuit|schematic|component" --type md
Length of output: 66 Script: #!/bin/bash
# Check the content of README.md for hardware-related context
rg -A 5 -B 5 "hardware|circuit|schematic|component" README.md
Length of output: 751 Script: #!/bin/bash
# Look for hardware-related files and directories
fd -t f "\.ino$|\.h$|\.cpp$|\.py$" -x rg -l "gpio|pin|sensor|arduino|raspberry|circuit"
# Check if there are any hardware config files
fd -t f "config.*" -x rg -l "hardware|device|sensor|gpio"
# Look for any build or circuit design files
fd "\.gerber$|\.brd$|\.sch$|\.stl$|\.scad$"
Length of output: 195 Script: #!/bin/bash
# List all files to understand project structure
fd -t f
# Check package management files for dependencies
fd "requirements.txt|package.json|Cargo.toml|go.mod" -x cat {}
Length of output: 86 |
||||||
|
||||||
### Implementation | ||||||
|
||||||
For Software: | ||||||
|
||||||
# Installation | ||||||
|
||||||
[commands] | ||||||
|
||||||
# Run | ||||||
|
||||||
Comment on lines
+48
to
+52
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. Add actual installation and run commands The installation and run commands are currently placeholders. Please add the actual commands for setting up and running the project. For example: # Installation
```bash
git clone https://github.com/username/antialgo
cd antialgo
npm install # For React frontend
pip install -r requirements.txt # For Python backend Run# Start backend
uvicorn main:app --reload
# Start frontend (in another terminal)
npm start
|
||||||
[commands] | ||||||
|
||||||
### Project Documentation | ||||||
|
||||||
Comment on lines
55
to
+56
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. Fix heading hierarchy The heading levels are inconsistent. "Project Documentation" and "Project Demo" should be H2 headings to maintain proper hierarchy. -### Project Documentation
+## Project Documentation
-### Project Demo
+## Project Demo Also applies to: 96-97 🧰 Tools🪛 Markdownlint55-55: Expected: h2; Actual: h3 (MD001, heading-increment) |
||||||
For Software: | ||||||
|
||||||
# Screenshots (Add at least 3) | ||||||
|
||||||
![Screenshot1](Add screenshot 1 here with proper name) | ||||||
*Add caption explaining what this shows* | ||||||
_Add caption explaining what this shows_ | ||||||
|
||||||
![Screenshot2](Add screenshot 2 here with proper name) | ||||||
*Add caption explaining what this shows* | ||||||
_Add caption explaining what this shows_ | ||||||
|
||||||
![Screenshot3](Add screenshot 3 here with proper name) | ||||||
*Add caption explaining what this shows* | ||||||
_Add caption explaining what this shows_ | ||||||
|
||||||
# Diagrams | ||||||
|
||||||
![Workflow](Add your workflow/architecture diagram here) | ||||||
*Add caption explaining your workflow* | ||||||
_Add caption explaining your workflow_ | ||||||
|
||||||
For Hardware: | ||||||
|
||||||
# Schematic & Circuit | ||||||
|
||||||
![Circuit](Add your circuit diagram here) | ||||||
*Add caption explaining connections* | ||||||
_Add caption explaining connections_ | ||||||
|
||||||
![Schematic](Add your schematic diagram here) | ||||||
*Add caption explaining the schematic* | ||||||
_Add caption explaining the schematic_ | ||||||
|
||||||
# Build Photos | ||||||
|
||||||
![Components](Add photo of your components here) | ||||||
*List out all components shown* | ||||||
_List out all components shown_ | ||||||
|
||||||
![Build](Add photos of build process here) | ||||||
*Explain the build steps* | ||||||
_Explain the build steps_ | ||||||
|
||||||
![Final](Add photo of final product here) | ||||||
*Explain the final build* | ||||||
_Explain the final build_ | ||||||
|
||||||
### Project Demo | ||||||
|
||||||
# Video | ||||||
|
||||||
[Add your demo video link here] | ||||||
*Explain what the video demonstrates* | ||||||
_Explain what the video demonstrates_ | ||||||
|
||||||
# Additional Demos | ||||||
[Add any extra demo materials/links] | ||||||
|
||||||
## Team Contributions | ||||||
- [Name 1]: [Specific contributions] | ||||||
- [Name 2]: [Specific contributions] | ||||||
- [Name 3]: [Specific contributions] | ||||||
[Add any extra demo materials/links] | ||||||
|
||||||
--- | ||||||
Made with ❤️ at TinkerHub Useless Projects | ||||||
|
||||||
Made with ❤️ at TinkerHub Useless Projects | ||||||
|
||||||
![Static Badge](https://img.shields.io/badge/TinkerHub-24?color=%23000000&link=https%3A%2F%2Fwww.tinkerhub.org%2F) | ||||||
![Static Badge](https://img.shields.io/badge/UselessProject--24-24?link=https%3A%2F%2Fwww.tinkerhub.org%2Fevents%2FQ2Q1TQKX6Q%2FUseless%2520Projects) | ||||||
|
||||||
|
||||||
|
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.
Fix the banner image path
The image path uses
user-attachments
which might not be accessible. Consider uploading the image to the repository's assets or using a relative path.