Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ranitmanik/codesnap
CodeSnap is a simple platform for creating, running, and sharing code snippets quickly and easily.
https://github.com/ranitmanik/codesnap
authjs codesnap full-stack full-stack-project fullstack-application fullstack-development nextjs nextjs14 nextui react vercel
Last synced: about 1 month ago
JSON representation
CodeSnap is a simple platform for creating, running, and sharing code snippets quickly and easily.
- Host: GitHub
- URL: https://github.com/ranitmanik/codesnap
- Owner: RanitManik
- License: mit
- Created: 2024-09-25T19:09:07.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-20T20:19:16.000Z (about 2 months ago)
- Last Synced: 2024-11-20T20:24:46.670Z (about 2 months ago)
- Topics: authjs, codesnap, full-stack, full-stack-project, fullstack-application, fullstack-development, nextjs, nextjs14, nextui, react, vercel
- Language: TypeScript
- Homepage: https://codesnap.pro
- Size: 4.67 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
CodeSnap – Create, Run & Share Code Snippets
View Demo
·
Report Bug
·
Request Feature
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](#overview)
- [Why CodeSnap?](#why-codesnap)
- [Technologies Used](#technologies-used)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Development Server](#running-the-development-server)
- [Building for Production](#building-for-production)
- [Linting and Formatting](#linting-and-formatting)
- [Contributing](#contributing)
- [Links](#links)
- [Contact](#contact)
- [Acknowledgments](#acknowledgments)
## 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:**
```bash
git clone https://github.com/RanitManik/CodeSnap.git
cd CodeSnap
```
2. **Install dependencies:**
```bash
npm install
```
or
```bash
yarn install
```
### Running the Development Server
To start the development server, run:
```bash
npm run dev
```
or
```bash
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:
```bash
npm run build
```
or
```bash
yarn build
```
The built files will be located in the `dist` directory.
### Linting and Formatting
To lint your code, run:
```bash
npm run lint
```
or
```bash
yarn lint
```
To format your code, run:
```bash
npm run format
```
or
```bash
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:
```bash
git checkout -b feature-name
```
3. Make your changes and commit them with clear, descriptive messages.
4. Push your changes to your fork:
```bash
git push origin feature-name
```
5. Open a pull request, detailing the changes and improvements you’ve made.
## Links
| Environment | Link |
|--------------------|------------------------------------------------------------|
| Development Server | [beta.codesnap.pro](https://beta.codesnap.pro) |
| Production Server | [codesnap.pro](https://www.codesnap.pro) |
## Contact
Social Media
Username
Link
Email
[email protected]
Email
LinkedIn
Ranit Manik
LinkedIn
Instagram
ranit_manik_
Instagram
Facebook
RanitKumarManik
Facebook
_Feel free to reach out if you have questions or just want to chat about web adventures!_
## Acknowledgments
This project wouldn't be possible without the collaboration and resources of the developer community. Thanks to the
community and tools like React and Nextjs. Special appreciation goes to friends and family. I hope it inspires further
learning.
---
Thank you for using CodeSnap! Happy coding! 👨💻