CodeFlow

Transform your code into a live storytelling experience.

CodeFlow is an app designed for YouTubers, bloggers, and anyone who wants to showcase their code with an engaging typewriter effect. The app dynamically reveals your code line-by-line, making it perfect for educational content, tutorials, or showcasing your programming skills to a broader audience.

Features

• Typewriter Effect: Display your code with a realistic typewriter effect to captivate your audience.
• Multiple Programming Languages: Support a total of 277 programming languages including Python, JavaScript, and more.
• Decluttered Interface: Select the programming language and enter your code in the first tab, then view and record the effect on another tab.
• Recording Functionality: This app has been created using Streamlit which has an in-built screen recording funtionality.

Installation

Prerequisites

To run this app locally, you need to have Python installed on your machine. The app is built using Streamlit, a Python library for creating interactive web apps.

Step 1: Clone the repository

First, clone the repository to your local machine:

git clone https://github.com/rajtilakjee/codeflow.git
cd codeflow

Step 2: Install Dependencies

Install the necessary dependencies using pip:

pip install -r requirements.txt

Step 3: Run the App

Once the dependencies are installed, you can start the app with the following command:

streamlit run app.py

Visit http://localhost:8501 in your browser to view the app.

Usage

• Select Programming Language: Choose the language of the code you want to showcase from a dropdown menu.
• Enter Code: Paste or type your code in the provided text area.
• Click on the Effect Tab: The typewriter effect will begin, revealing your code line-by-line.

Contributing

We welcome contributions! If you'd like to improve the app, please fork the repository and create a pull request. Make sure to follow the guidelines and write clear commit messages.

How to Contribute

• Fork the repo.
• Create a new branch (git checkout -b feature-name).
• Make your changes.
• Commit your changes (git commit -am 'Add feature').
• Push to the branch (git push origin feature-name).
• Create a pull request.

License

This project is licensed under GPL-3.0 - see the LICENSE file for details.

Contact

For support, please create a GitHub issue.