Skip to content

sarvaSanjay/AcademicWeapon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 

Repository files navigation

            ░█████╗░░█████╗░░█████╗░██████╗░███████╗███╗░░░███╗██╗░█████╗░  ░██╗░░░░░░░██╗███████╗░█████╗░██████╗░░█████╗░███╗░░██╗
            ██╔══██╗██╔══██╗██╔══██╗██╔══██╗██╔════╝████╗░████║██║██╔══██╗  ░██║░░██╗░░██║██╔════╝██╔══██╗██╔══██╗██╔══██╗████╗░██║
            ███████║██║░░╚═╝███████║██║░░██║█████╗░░██╔████╔██║██║██║░░╚═╝  ░╚██╗████╗██╔╝█████╗░░███████║██████╔╝██║░░██║██╔██╗██║        
            ██╔══██║██║░░██╗██╔══██║██║░░██║██╔══╝░░██║╚██╔╝██║██║██║░░██╗  ░░████╔═████║░██╔══╝░░██╔══██║██╔═══╝░██║░░██║██║╚████║
            ██║░░██║╚█████╔╝██║░░██║██████╔╝███████╗██║░╚═╝░██║██║╚█████╔╝  ░░╚██╔╝░╚██╔╝░███████╗██║░░██║██║░░░░░╚█████╔╝██║░╚███║
            ╚═╝░░╚═╝░╚════╝░╚═╝░░╚═╝╚═════╝░╚══════╝╚═╝░░░░░╚═╝╚═╝░╚════╝░  ░░░╚═╝░░░╚═╝░░╚══════╝╚═╝░░╚═╝╚═╝░░░░░░╚════╝░╚═╝░░╚══╝

Introducing Academic Weapon: A Source of Student Inspiration

Our Story 🌟

Within the heart of every student, there's a shared challenge: turning class notes into powerful study tools. We've been there, navigating the maze of traditional note-taking 📝, wrestling with digital tools like Evernote or OneNote that lack automation 🤖. We've felt the pain of inputting data manually into popular flashcard apps like Anki or Quizlet 🧠💡, and the frustration of crafting quizzes on platforms like Google Forms 📊. Even those pre-made study materials on SparkNotes and CliffsNotes don't always hit the mark for our specific coursework 📖❌.

In response, we harnessed the magic of GPT-3.5 to create Academic Weapon, a revolutionary tool. We've redefined the way you interact with your notes.

What Academic Weapon Does 🚀

Your notes, whether they're digital or handwritten in PDFs, or even scanned from physical pages, are your canvas 🎨. Academic Weapon is the artist, effortlessly transforming your notes into a masterpiece of learning 📚. You'll have the choice to review your materials through captivating quizzes or dynamic flashcards. Get ready to experience a new dimension in studying! 🤯📝📊🔥

How We Built It

We developed our app using a combination of technologies, including Microsoft Azure's OCR for extracting text from digital or handwritten notes. We used React and HTML/CSS to create an engaging user interface for interactive flashcards and quizzes. Additionally, we harnessed the power of ChatGPT-3.5 to generate content for our quizzes and flashcards. Last but not least, we savored the delightful taste of bubble tea!🍵💭

Challenges we ran into

During the development process, we encountered several challenges when connecting our frontend, built using React, with the backend, implemented in Python Flask. The major hurdles we faced included:

API Endpoint Setup: Creating and configuring the API endpoints to establish a seamless connection between the frontend and backend. This involved defining routes, handling requests, and ensuring proper data flow.

Async Functions: Implementing asynchronous functions to handle concurrent operations efficiently. This was crucial for managing multiple requests and ensuring smooth interactions between the frontend and backend.

Efficient Third-Party Service Integration: Integrating third-party services, such as Azure, presented challenges in terms of optimizing data retrieval and ensuring timely responses. We needed to make efficient and well-organized requests to external services to minimize latency and provide a smooth user experience.

These challenges required meticulous planning and collaboration between the frontend and backend development teams to overcome. In the end, our efforts led to a robust and fully integrated system that seamlessly connects user interactions on the frontend with data processing and services on the backend.

Accomplishments that we're proud of

As we reflect on our journey, there are certain accomplishments that stand out:

  • Meeting Project Scope: We take immense pride in successfully completing our project within the predefined scope. This means we effectively delivered all the features and functionalities we initially set out to achieve. This accomplishment signifies our commitment to project management and execution. 🌟🏆
  • Effective Collaboration: Our team's ability to work seamlessly and cohesively throughout the project is another accomplishment we hold in high regard. The synergy among team members, clear communication, and shared vision led to a harmonious and productive work environment. 🤝💼
  • Innovation and Problem-Solving: We encountered and overcame various challenges during the project, which allowed us to showcase our innovation and problem-solving skills. Our ability to find creative solutions and adapt to unforeseen circumstances is something we are proud of. 💡🔧

What we learned

Throughout the development of our project, we gained valuable insights and skills:

  • Integration of 3rd Party Services: 🌐 We mastered the art of integrating third-party services, like Azure, into our project. This involved understanding APIs, authentication, and effectively utilizing external services to enhance our application's functionality.

  • API-Endpoint Setup: 🚀 We honed our skills in setting up API endpoints, a fundamental aspect of connecting our frontend and backend. This process included route configuration, request handling, and ensuring smooth data exchange.

  • Efficient Data Handling: 📊 We learned the importance of efficient data handling to optimize the performance of our application. This included data retrieval, storage, and transmission, all with a focus on minimizing latency and improving the user experience.

These lessons not only helped us overcome the challenges we encountered but also enriched our understanding of software development, making us better equipped for future projects and innovations. 🚀💡

What's next for Academic Weapon

  • Enable users to export their flashcards and quizzes in formats of their choice.
  • Develop a mobile-friendly version for enhanced accessibility.
  • Implement a feature for users to save their profiles along with the flashcards and quizzes they generate.

Built With

  • React: ⚛️
  • JavaScript: 📜
  • HTML/CSS: 🌐🎨
  • Azure: ☁️
  • Python Flask: 🐍🌐

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •