https://github.com/sammarxz/codart
Create beautiful images of your source code
https://github.com/sammarxz/codart
code-to-image nextjs react-editor
Last synced: 6 months ago
JSON representation
Create beautiful images of your source code
- Host: GitHub
- URL: https://github.com/sammarxz/codart
- Owner: sammarxz
- Created: 2023-12-27T21:23:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-28T16:26:26.000Z (over 1 year ago)
- Last Synced: 2024-11-29T18:31:10.842Z (6 months ago)
- Topics: code-to-image, nextjs, react-editor
- Language: TypeScript
- Homepage: https://codart-five.vercel.app
- Size: 105 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codart
Codart let you create beautiful images of your source code. We have several customization options, from backgrounds with beautiful gradients, paddings and themes.
## Table of Contents
- [Technologies](#technologies)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
## Technologies
* [React](https://react.dev/) (with contextAPI and useReducer)
* [Next 14](https://nextjs.org/)
* [TailwindCSS](https://tailwindcss.com/) for styles
* [react-outside-click-handler](https://www.npmjs.com/package/react-outside-click-handler) to create simple `` Component
* [react-ace](https://www.npmjs.com/package/react-ace) for the code editor
* [lucide-react](https://lucide.dev/icons/) for the icons
* [dom-to-image](https://github.com/tsayen/dom-to-image/blob/master/src/dom-to-image.js) to convert the `` with the CodeEditor to an `image/png`
## Getting Started
[Provide information on how to get started with your project. Include any prerequisites or dependencies that need to be installed, and steps to run the project locally.]
### Installation
1. Clone the repository and install the dependencies:
```bash
git clone https://github.com/sammarxz/codart.git
cd codart
yarn
```
### Usage
1. Start the development server
```bash
yarn dev
```
2. Go to https://localhost:3000