Skip to content

mini9yo/AssignMap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AssignMap

StormHacks 2024

AssignMap

What is AssignMap?

AssignMap, "Assignment" + "GuidMap," is an AI-powered assignment subtask and rubric generator designed to enhance the educational experience by helping students and teachers efficiently manage their assignments. Using OpenAI's API, AssignMap creates customized subtasks and rubrics to fit the unique needs of each assignment. By combining elements of social good and artificial intelligence, AssignMap offers practical educational tools that make learning and teaching more effective and enjoyable.

Why did we create AssignMap?

In today's fast-paced educational environment, students and teachers both often struggle with managing multiple assignments and understanding their requirements. AssignMap addresses these challenges by:

  • Enhancing Task Management: Break down assignments into manageable subtasks.
  • Providing Clear Guidelines: Generate rubrics that clarify assessment criteria.
  • Supporting Diverse Learning Styles: Help students organize their work in a way that suits their learning preferences.

How to Use AssignMap

  1. Clone the repository:

    git clone git@github.com:mini9yo/AssignMap.git
  2. Navigate to the backend directory:

    cd backend
  3. Create and activate a virtual environment:

    python3 -m venv venv
    source venv/bin/activate  # For macOS/Linux
    venv\Scripts\activate  # For Windows
  4. Install the dependencies:

    pip install -r requirements.txt
  5. Run the application:

    python app.py
  6. Open your browser and go to http://localhost:8000/ to start organizing your assignments.

  • Note: Ensure you have the necessary API keys configured for the OpenAI API.

Example Files

Users can find example assignment description text files in the folder named example_files, located directly under the root directory. These files can be used for a better understanding of how to use the application. All copyrights of the text files belong to SFU professors.

Challenges We ran into

Our team ran into issues mainly with integrating what we coded in the backend with what we developed for the front. These issues lead to us having to scrap the entire database setup that was intializeed in the backend operations. Mainly our issues just stemmed from the lack of experience in webdesign compared to other aspects of the project.

What We Learned

Basically a very simple project can end up being much more time consuming than expected. As this is Kaiden's first hackathon that was a big shock to him and specifically Kaylee learned quite bit more about webdessign and frontend development. As well our team learned how to implement and develop an app using OpenAI API.

What we are proud of

We are proud that we have a completed project that can be further developed and have a stronger implementation. We are also proud that we competed in this hackathon because we had a great time and learned a lot. As well we are proud of cohesive teamwork throughout the process.

What's Next?

Our team is passionate about continuing to develop AssignMap beyond the StormHacks 2024 hackathon. We envision a robust user management system where users can:

  • View Generated Plans: Access and manage their generated subtask plans and rubrics from a personal library.
  • Customize Their Experience: Edit, add, or delete AI-generated subtasks and criteria, ensuring that the tool meets their specific needs.
  • Upload Multi-Modal Content: Allow users to upload various file types, enabling a more integrated and flexible approach to assignment management.

Technologies Used

  • Python
  • JavaScript
  • HTML
  • CSS
  • OpenAI API
  • Figma

Our Team

  • Kaylee Ryu
  • Kaiden Palmer

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •