search

cmgriffing / giffium

Create and share beautiful gifs of your source code diffs.
https://giffium.com
MIT License
9 stars 7 forks source link

readme

Giffium

Giffium

pnpm turborepo

Giffium is a tool to generate a socially shareable gif from a diff of two snippets of code/config.

Inspiration

Giffium was inspired by Shiki Magic Move and Carbon/Ray.so.

It was created as part of the SolidJS Hackathon

Libraries

This project leans heavily on these libraries:

Getting Started

To get started with the project, first install pnpm and install dependencies with pnpm i.

Project Commands

List of cli commands available from a project root.

To use the commands, first install pnpm and install dependencies with pnpm i.

pnpm run dev
# Builds all packages in watch mode, and starts all playgrounds
# turbo run dev --parallel

pnpm run build
# Builds all the packages in the monorepo
# turbo run build --filter=!./playgrounds/*

pnpm run format
# Formats the repository with prettier
# prettier -w \"packages/**/*.{js,ts,json,css,tsx,jsx,md}\" \"playgrounds/**/*.{js,ts,json,css,tsx,jsx,md}\"

pnpm run update-deps
# Updates all dependencies in the repository
# pnpm up -Lri

Contributing

Giffium is a monorepo managed by turborepo. The project also requires the use of pnpm to manage dependencies.

Getting Started

To get started with the project, first install pnpm and install dependencies with pnpm i.

pnpm i

Building

To build the project, run the following command:

pnpm run build

This will build all the packages in the monorepo.

If you run into any issues, please check the pnpm docs for more information.

Running the Playground

To run the playground, run the following command:

pnpm run dev

This will start all the playground in watch mode.

SolidJS

The project is built using SolidJS. If you are new to SolidJS, we recommend checking out their documentation and tutorials.

License

MIT License

Copyright (c) 2024 Chris Griffing

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.