https://github.com/muhammadsaim/codesnap
Welcome to CodeSnap, an open-source project inspired by Carbon.now.sh. This project allows you to create and share beautiful images of your source code with a simple and intuitive interface. The backend is powered by Flask, and the frontend is built with Next.js.
https://github.com/muhammadsaim/codesnap
flask flask-api flask-restful flask-sqlalchemy nextjs nextjs14 python3 reactjs
Last synced: about 2 months ago
JSON representation
Welcome to CodeSnap, an open-source project inspired by Carbon.now.sh. This project allows you to create and share beautiful images of your source code with a simple and intuitive interface. The backend is powered by Flask, and the frontend is built with Next.js.
- Host: GitHub
- URL: https://github.com/muhammadsaim/codesnap
- Owner: MuhammadSaim
- License: gpl-3.0
- Created: 2024-05-29T16:00:25.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-30T05:31:54.000Z (about 1 year ago)
- Last Synced: 2025-03-30T06:23:19.136Z (about 1 year ago)
- Topics: flask, flask-api, flask-restful, flask-sqlalchemy, nextjs, nextjs14, python3, reactjs
- Language: Python
- Homepage:
- Size: 411 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CodeSnap
**CodeSnap** is an open-source project inspired by [Carbon.now.sh](https://carbon.now.sh). It allows users to create and share beautiful images of their source code with a simple and intuitive interface. The project consists of a Flask backend and a Next.js frontend.
## Table of Contents
1. [Project Structure](#project-structure)
2. [Features](#features)
3. [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
4. [Running the Application](#running-the-application)
5. [Contributing](#contributing)
6. [License](#license)
## Project Structure
The repository is organized into two main folders:
- `frontend/` - Contains the Next.js frontend code.
- `backend/` - Contains the Flask backend code.
Each folder has its own README.md with detailed instructions for setting up and running the respective parts of the project.
## Features
- Responsive design for optimal viewing on any device
- Syntax highlighting for various programming languages
- Custom themes and styling options
- Image export functionality
- RESTful API to handle code snippet processing
## Getting Started
To get a local copy up and running, follow these steps.
### Prerequisites
- Python 3.10 or higher
- Node.js and npm/yarn
- pip (Python package installer)
- virtualenv (optional, but recommended)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/MuhammadSaim/CodeSnap.git codesnap
cd codesnap
```
2. Follow the installation instructions in the respective frontend and backend folders.
- [Frontend](./frontend/README.md) Go to the frontend [README](./frontend/README.md) for instalation instructions
- [Backend](./backend/README.md) Go to the frontend [README](./backend/README.md) for instalation instructions
### Contributing
We welcome contributions to improve CodeSnap. To contribute, please follow these steps:
- Fork the repository.
- Create a new branch: git checkout -b feature/your-feature-name.
- Make your changes and commit them: git commit -m 'Add some feature'.
- Push to the branch: git push origin feature/your-feature-name.
- Open a pull request.
Please ensure that your code adheres to the existing coding conventions and includes appropriate tests.
### License
This project is licensed under the MIT License. See the LICENSE file for details.
Feel free to reach out if you have any questions or need further assistance. Happy coding!