Skip to content

Pitchouneee/code-journey

Repository files navigation

🚀 Code Journey

🎬 Presentation

Code Journey is React + TypeScript tool that lets you easily create multi-step code animations to enhance your technical presentations. The goal of this project is to break down a code snipper into multiple steps and animate those steps to visually highlight changes, additions, or refactorings in a progressive and engaging way.

💡 Project origin : When preparing technical slides, it can be tricky to clearly show how a piece of code evolves. Code Journey solves this by providing a dynamic, step-by-step preeiw that guides your audience through th journey of the code -- from the initial version to the final result.

🌟 Features

  • 🎨 Syntax highlighting powered by Highlight.js
  • 🔄 Auto-play with Play/Pause controls
  • Add and 🗑️ Remove code steps dynamically
  • ✏️ Live editingof the code for each step
  • 🌐 Language selection from a wide list supported by Monaco Editor

🛠️ Installation & Getting Started

  1. Clone the repository :
   git clone https://github.com/Pitchouneee/code-journey.git
   cd code-journey
  1. Install dependencies :
   npm install
  1. Start the development server :
   npm run dev
  1. Open your browser at http://localhost:5173 🌐

🚀 How to use

  • ▶️ Play / Pause : Start or pause the step-by-step animation
  • Add Step : Create a new step with default code
  • 🖊️ Edit : Click on a step to edit its code
  • 🌐 Select language : Choose a category and a language to match your syntax highlighting

📈 Roadmap & Contributions

  • ✅ Step-by-step animation
  • ✅ Language selection and syntax highlighting
  • Export animation output (coming soon: GIF, video, sequential images)

Contributions are welcome! Feel free to open issues or pull requests to :

  • Add export options (GIF, video, image sequences) 📹
  • Improve the UI and overall user experience ✨
  • Expand support for new languages or themes 🛠️

📜 License

This project is licensed under the MIT License.
Feel free to use, modify, and distribute it as you wish.

About

Animate code step-by-step for talks, slides, and reviews. A visual storytelling tool for code

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •