Skip to content

LitMood is an AI-powered book recommendation platform that reads your emotional state and matches you with the perfect literary companion for your current mood.

Notifications You must be signed in to change notification settings

code-techhb/litmood

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 

Repository files navigation

LitMood: Mood-Based Book Recommendation App 📚✨

LitMood Preview

LitMood is an innovative book recommendation application that suggests reading material based on your current mood. Using advanced mood analysis and the Open Library API, it provides personalized book recommendations that match your emotional state.

✨ Features

  • Mood Analysis: Advanced mood interpretation using natural language processing
  • Curated Recommendations: Carefully balanced selection of both classic and contemporary books
  • Book Details: Comprehensive information including covers, ratings, and publication years
  • Direct Links: Easy access to full book information on Open Library
  • Social Sharing: Share your mood-based recommendations with friends
  • Responsive Design: Seamless experience across all devices

🛠️ Technology Stack

Frontend

  • React.js
  • React Router for navigation
  • CSS Modules for styling
  • Lucide React for icons

Backend

  • Node.js
  • Express.js
  • Groq API for mood analysis
  • Open Library API for book data

🚀 Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn
  • Groq API key

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/litmood.git
cd mood-to-book
  1. Install dependencies for both frontend and backend:
# Install frontend dependencies
cd frontend
npm install

# Install backend dependencies
cd ../backend
npm install
  1. Create a .env file in the backend directory:
GROQ_API_KEY=your_groq_api_key
  1. Start the development servers:
# Start backend server
cd backend
npm start

# In a new terminal, start frontend
cd frontend
npm run dev
  1. Open http://localhost:5173 in your browser

🎨 Features in Detail

Mood Analysis

  • Natural language processing to understand user's emotional state
  • Converts complex mood descriptions into targeted book recommendations

Book Recommendations

  • Balances between classic and contemporary literature
  • Provides high-rated books matching the user's mood
  • Includes cover images, author information, and ratings

Social Features

  • Share recommendations via native share functionality
  • Connect with reading buddies through Instagram
  • Create a community of mood-based readers

📱 Responsive Design

  • Fully responsive layout
  • Optimized for both desktop and mobile devices
  • Smooth animations and transitions
  • Intuitive user interface

Deployed Version 🌐

  • You can check out the deployed version of the app here 📚
  • Watch the walkthrough of the project on YouTube: LitMood Demo 🎥

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Open Library for their comprehensive book API
  • Groq for natural language processing capabilities
  • Lucide for beautiful icons
  • Freesound for high-quality audio tracks

📬 Contact

Feel free to reach out for questions, suggestions, or just to share your reading experience 🤩!


Made with 📚 and ❤️ by Houlaymatou B. at the ColorStack Winter Break 2024 Hackathon

About

LitMood is an AI-powered book recommendation platform that reads your emotional state and matches you with the perfect literary companion for your current mood.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published