GithubHelp home page GithubHelp logo

emanalytics7 / studycraft Goto Github PK

View Code? Open in Web Editor NEW
2.0 2.0 0.0 5.48 MB

Create your personalized learning schedule in a pdf format

License: MIT License

Python 100.00%
exa-api llama3-70b-8192 pdfgenerator personalization python streamlit

studycraft's Introduction

StudyCraft

StudyCraft Logo

Your Personal AI Study Buddy

๐Ÿ‘‰ Try StudyCraft Now!

What is StudyCraft?

StudyCraft is a web application that creates a personalized learning schedule of your preferred style and generates a comprehensive PDF of the plan.

See StudyCraft in Action

demo.mp4

Features

  • Custom Study Plans: Tailored just for you and your learning style
  • AI-Powered Content: Uses smart AI to create study materials
  • Resource Finder: Automatically finds and includes helpful resources
  • PDF Magic: Turns your study plan into a neat, downloadable PDF

Tech Stack

  • Groq API: Powers our smart AI brain (Llama3-70b)
  • Exa API: Helps find the best study resources
  • Google Fonts: Makes your study plan look cool (i used "Anonymous Pro")

File Structure

StudyCraft/
โ”‚
โ”œโ”€โ”€ artifacts/               # Contains generated PDFs and other output files
โ”‚   โ”œโ”€โ”€ example_output.pdf
โ”‚   โ””โ”€โ”€ ...
โ”‚
โ”œโ”€โ”€ fonts/                   # Includes custom fonts used in PDF generation
โ”‚   โ”œโ”€โ”€ AnonymousPro-Regular.ttf
โ”‚   โ””โ”€โ”€ ...
โ”‚  
โ”œโ”€โ”€ app.py                   # Main Streamlit application file
โ”‚                            
โ”œโ”€โ”€ content_generation.py   # Contains the main logic for generating content based on user input and templates.
โ”‚                      
โ”‚
โ”œโ”€โ”€ pdf_conversion.py       # Uses ReportLab to style and compile the final PDF documents.                           
โ”‚
โ””โ”€โ”€ prompt_template.txt      # Template for AI content generation prompts

Getting Started

What You'll Need

  • Python 3.10 or newer
  • Groq & Exa API keys (optional, in case my apis dont work!)

Setup Steps

  1. Grab the Code
    git clone https://github.com/Emanalytics7/StudyCraft.git
    cd StudyCraft
  2. Install the Dependencies
pip install -r requirements.txt
  1. Set Up Your API Keys Create a .env file and add your API keys (if you have them)

  2. Launch StudyCraft

streamlit run app.py

How to Use

  • Open StudyCraft in your browser
  • Tell it your study goals and how you like to learn
  • Click to generate your personalized study plan
  • Download your new PDF and start learning!

Contribute

I'd love your help to make StudyCraft even better!

How to Join In

  • Fork the project
  • Create your feature branch (git checkout -b feature/AmazingFeature)
  • Commit your changes (git commit -m 'Add some AmazingFeature')
  • Push to the branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

Ideas for Improvement

  • Progress trackers and charts
  • More advanced AI study content
  • Links to additional learning resources
  • Customizable PDF themes and layouts

License

This project is under the MIT License. Check out the LICENSE file for the legal details.

If you found StudyCraft helpful & amazing, please give it a star! โญ This was a fun project I did just for fun, and I hope you like it


Made with โค๏ธ by Eman | ยฉ 2024 StudyCraft

LinkedIn โ€ข Email

studycraft's People

Contributors

emanalytics7 avatar

Stargazers

Muhammad Awwab Khan avatar  avatar

Watchers

Lucian avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.