CodeSnap is an open-source project inspired by 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.
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.
- 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
To get a local copy up and running, follow these steps.
- Python 3.10 or higher
- Node.js and npm/yarn
- pip (Python package installer)
- virtualenv (optional, but recommended)
-
Clone the repository:
git clone https://github.com/MuhammadSaim/CodeSnap.git codesnap cd codesnap -
Follow the installation instructions in the respective frontend and backend folders.
- Frontend Go to the frontend README for instalation instructions
- Backend Go to the frontend README for instalation instructions
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.
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!
