CodeSnap – Create, Run & Share Code Snippets

Welcome to **CodeSnap**, a lightweight app for creating, sharing, running, and viewing code snippets with ease. Built to simplify code sharing, CodeSnap enables users to generate a shareable link for any snippet, making collaboration more efficient and accessible.

Table of Contents

• Overview
  • Why CodeSnap?
  • Technologies Used
  • Features
• Getting Started
  • Prerequisites
  • Installation
  • Running the Development Server
  • Building for Production
  • Linting and Formatting
• Contributing

Overview

Why CodeSnap?

CodeSnap was created to provide an easy-to-use solution for sharing code snippets, making collaboration faster and more intuitive. The platform supports syntax highlighting, code editing, and live code execution, so you can showcase and test code within seconds.

Technologies Used

Features

• Real-time Code Editor: Built with Monaco, the editor offers syntax highlighting, code completion, and error handling.
• Live Code Execution: Test code snippets in real-time.
• Firebase Integration: Reliable backend for storing, retrieving, and managing snippets.
• Responsive Design: Optimized for both desktop and mobile.
• Sharing Made Easy: Generate and share links with a single click.

Getting Started

Prerequisites

• Node.js (>= 20.0.0)
• npm (>= 10.0.0) or yarn (>= 1.22.0)

Installation

1. Clone the repository:

   git clone https://github.com/RanitManik/CodeSnap.git
   cd CodeSnap

2. Install dependencies:

   npm install

   or

   yarn install

Running the Development Server

To start the development server, run:

npm run dev

or

yarn dev

Open your browser and navigate to http://localhost:5173 to interact with CodeSnap.

Building for Production

To build the application for production, run:

npm run build

or

yarn build

The built files will be located in the dist directory.

Linting and Formatting

To lint your code, run:

npm run lint

or

yarn lint

To format your code, run:

npm run format

or

yarn format

Contributing

Contributions to CodeSnap are welcome! To contribute:

1. Fork the repository.

2. Create a new branch for your feature or bug fix:

   git checkout -b feature-name

3. Make your changes and commit them with clear, descriptive messages.

4. Push your changes to your fork:

   git push origin feature-name

5. Open a pull request, detailing the changes and improvements you’ve made.

---

Thank you for using CodeSnap! Happy coding! 👨‍💻