diff --git a/README.md b/README.md index 1daffed71..b89debb4f 100644 --- a/README.md +++ b/README.md @@ -1,101 +1,112 @@ readme-banner -# [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? ### 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] ## 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] ### Implementation + For Software: + # Installation + [commands] # Run + [commands] ### Project Documentation + 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) - - -