Skip to content

EcodeJR/SnapSolve

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

73 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

SnapSolve - Your AI-Powered Study Assistant

Live Demo License

πŸ“š Overview

SnapSolve is an intelligent educational platform that combines AI-powered tools to enhance learning experiences. Whether you're studying complex topics, solving math problems, or analyzing text, SnapSolve provides comprehensive assistance through multiple features.

Key Features

  • πŸ“Έ Image Analysis: Upload images of problems or text for instant analysis
  • πŸ’¬ AI Chat: Engage with our AI tutor for detailed explanations
  • πŸ“– Study Guide Generation: Create comprehensive study materials
  • πŸ“ Text Analysis: Get in-depth analysis of written content

πŸš€ Live Demo

Experience SnapSolve in action: Live Demo

πŸ› οΈ Technologies Used

  • Frontend:

    • React.js
    • TailwindCSS
    • Axios
    • React Router
  • Backend:

    • Node.js
    • Express.js
    • MongoDB
    • Google AI API

πŸ—οΈ Project Structure

SnapSolve/
β”œβ”€β”€ frontend/              # React frontend application
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ components/    # Reusable components
β”‚   β”‚   β”œβ”€β”€ pages/        # Page components
β”‚   β”‚   └── utils/        # Utility functions
β”‚   └── public/           # Static files
└── backend/              # Node.js backend server
    β”œβ”€β”€ routes/          # API routes
    β”œβ”€β”€ ai/             # AI integration
    └── db/             # Database configuration

🚦 Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • MongoDB
  • Google AI API Key
  • npm or yarn

Installation

  1. Clone the repository
git clone https://github.com/EcodeJR/snapsolve.git
cd snapsolve
  1. Set up the backend
cd backend
npm install

Create a .env file in the backend directory:

PORT=8080
MONGODB_URI=your_mongodb_uri
AI_API_KEY=your_google_ai_api_key
JWT_SECRET_KEY=your_jwt_secret
  1. Set up the frontend
cd frontend
npm install

Create a .env file in the frontend directory:

VITE_NODE_ENV=development
VITE_API_URL_DEV=http://localhost:8080
VITE_API_URL_PROD=your_production_api_url

Running the Application

  1. Start the backend server
cd backend
npm run dev
  1. Start the frontend development server
cd frontend
npm run dev

The application will be available at http://localhost:5173

🀝 Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

πŸ“„ License

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

πŸ‘₯ Contact

EcodeJR - @EcodeJR

Project Link: https://github.com/EcodeJR/snapsolve

πŸ™ Acknowledgments


Made with ❀️ by EcodeJR

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages