Skip to content

AwaisCoder/snyppit

Repository files navigation

Here’s a structured README file for your project, "Snyppit":


Snyppit - SaaS Code Editor 🚀

Welcome to Snyppit, a powerful online code editor built with Next.js 15, Convex, Clerk, and TypeScript. Whether you're a developer looking for a flexible environment to work on projects or a community member eager to share code, Snyppit is designed to cater to all your coding needs with an intuitive interface and advanced features.

Table of Contents

Tech Stack 🚀

  • Next.js 15 - Framework for React applications, providing server-side rendering and static site generation.
  • Convex - Backend framework for building real-time applications.
  • Clerk - Authentication service for seamless user sign-up and login.
  • TypeScript - Adds static typing to JavaScript for enhanced code quality and developer experience.

Features 💡

💻 Online IDE with Multi-language Support

  • Supports 10 programming languages to cater to a variety of coding projects.

🎨 Customizable Experience

  • Choose from 5 VSCode-like themes for a personalized coding environment.

✨ Smart Output Handling

  • Displays Success and Error states for clear and actionable feedback.

💎 Flexible Pricing

  • Free and Pro plans to suit both casual users and professional developers.

🤝 Community-Driven Code Sharing

  • Share your code with the community or access others' projects in a collaborative environment.

🔍 Advanced Filtering & Search

  • Quickly find what you need with advanced filtering and search capabilities.

👤 Personal Profile

  • Track your execution history and manage projects with an easy-to-use profile interface.

📊 Comprehensive Statistics Dashboard

  • View detailed metrics to track your progress and project activity.

⚙️ Customizable Font Size Controls

  • Adjust font size to your comfort, improving readability and productivity.

🔗 Webhook Integration Support

  • Integrate external services with webhooks for automated workflows and notifications.

🌟 Professional Deployment Walkthrough

  • Receive a step-by-step deployment guide to help launch your projects smoothly.

Pricing 💸

  • Free Plan: Get started with essential features and support for the most popular languages.
  • Pro Plan: Access advanced features, increased language support, custom theming, and more.

Community 🌍

  • Engage with a community-driven code-sharing system to collaborate, learn, and grow together.
  • Share your code and view the work of others for inspiration and learning.

Profile & Dashboard 📊

  • Track your coding activities through your personal profile, which includes an execution history.
  • Use the statistics dashboard to see key metrics and insights about your coding journey.

Deployment Walkthrough 🌱

  • A detailed deployment walkthrough will guide you through the process of deploying your project to production. It includes best practices and professional tips.

Getting Started 🚀

To get started with Snyppit, follow these steps:

  1. Clone this repository:

    git clone https://github.com/your-username/snyppit.git
  2. Install dependencies:

    npm install
  3. Run the development server:

    npm run dev
  4. Visit http://localhost:3000 to view the app in your browser.

  5. Set up authentication via Clerk by following the Clerk documentation.

License 📄

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