Skip to content

TheAgencyMGE/Clixel

Repository files navigation

Clixel

License: MIT TypeScript React Vite

An AI-powered, free productivity suite designed specifically for students and educators. Create professional presentations, documents, and spreadsheets with intelligent assistance.

🌟 Features

📊 Presentation Creator

  • AI-powered slide generation and content suggestions
  • Professional templates for educational content
  • Interactive 3D elements and animations
  • Real-time collaboration capabilities
  • Export to multiple formats (PDF, PPTX, HTML)

📝 Document Editor

  • Intelligent writing assistance and grammar checking
  • Markdown support with live preview
  • AI-enhanced content generation
  • Collaborative editing features
  • Document templates for academic writing

📈 Spreadsheet Tools

  • Smart formula suggestions and auto-completion
  • Data analysis and visualization tools
  • Template library for common educational use cases
  • Import/export support for Excel and CSV formats
  • Built-in calculators and statistical functions

🤖 AI Integration

  • Content generation powered by Google's Generative AI
  • Writing enhancement and grammar suggestions
  • Formula assistance and data analysis
  • Intelligent template recommendations

🎯 Educational Focus

  • 100% free for students and educators
  • No registration required
  • Privacy-focused design
  • Offline capabilities
  • Mobile-responsive interface

🚀 Getting Started

Prerequisites

  • Node.js (version 16.0 or higher)
  • npm or yarn package manager

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/clixel.git
    cd clixel/Clixel
  2. Install dependencies

    npm install
  3. Set up environment variables

    cp .env.example .env
    # Add your Google AI API key to the .env file
  4. Start the development server

    npm run dev
  5. Open your browser Navigate to http://localhost:5173 to view the application.

Building for Production

# Create an optimized production build
npm run build

# Preview the production build locally
npm run preview

🛠️ Tech Stack

📁 Project Structure

src/
├── components/          # Reusable UI components
│   ├── layout/         # Layout components (Navigation, etc.)
│   └── ui/             # shadcn/ui components
├── pages/              # Application pages/routes
│   ├── Index.tsx       # Landing page
│   ├── SlidesEditor.tsx # Presentation editor
│   ├── DocsEditor.tsx  # Document editor
│   ├── SheetsEditor.tsx # Spreadsheet editor
│   ├── Templates.tsx   # Template gallery
│   ├── Projects.tsx    # Project management
│   └── Help.tsx        # Help and documentation
├── data/               # Static data and templates
├── hooks/              # Custom React hooks
├── lib/                # Utility functions and configurations
├── services/           # API services and integrations
├── types/              # TypeScript type definitions
└── assets/             # Static assets (images, icons)

🎨 Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run build:dev - Build for development
  • npm run preview - Preview production build
  • npm run lint - Run ESLint

🌐 Deployment

The application can be deployed to various platforms:

Vercel (Recommended)

npm install -g vercel
vercel --prod

Netlify

npm run build
# Upload the 'dist' folder to Netlify

GitHub Pages

npm run build
# Deploy the 'dist' folder to your gh-pages branch

🤝 Contributing

We welcome contributions from the community! Please read our Contributing Guidelines for details on how to submit pull requests, report issues, and contribute to the project.

  1. Fork the repository
  2. Create your 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.

🙏 Acknowledgments

  • shadcn/ui for the beautiful component library
  • Google AI for generative AI capabilities
  • Lucide for the icon set
  • The open-source community for the amazing tools and libraries

📞 Support


Made with ❤️ for educators and students worldwide
Free • Open Source • Privacy Focused

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages