FlutterShow

KO | EN

gitlite — search

#javascript #python #android #chat #ios #server #bot #telegram-bot #docker #bigdata #scala #shell

★ 78 Open GitHub ↗

Unleash your creativity with presentations like never before! FlutterShow is an easy-to-use framework built in Flutter for crafting engaging and interactive presentations.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FlutterShow⚡️ - Presentations in Flutter

![FlutterShow Logo](https://raw.githubusercontent.com/lucas-goldner/FlutterShow/main/docs/images/fluttershow.png)\
[![style: very good analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg)](https://pub.dev/packages/very_good_analysis)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Unleash your creativity with presentations like never before! FlutterShow⚡️ is an easy-to-use framework built in Flutter
for crafting engaging and interactive presentations.\
**Full documentation 📄** showcasing all slides and code snippets to **speed up your development time** available here: https://flutter-show-docs.vercel.app/#/

## Project Setup

### Usage

Feel free to either **fork** or **clone** the repo, whatever you prefer.\
Select branch `main` for latest stable version.\
Select latest release branch `release/1.2.0` for newest features.

### Running FlutterShow⚡️

```bash
# (Optional) Checkout release branch for newest features
$ git checkout release/1.2.0

# Get dependencies
$ flutter pub get

# If language files were not generated
$ flutter pub run intl_utils:generate

# (Optional) If you want to run it on macOS
$ cd macos && pod install && cd ..

# Run the app (for example on macOS) OR use the pre-built `launch.json`
$ flutter run -d macos
```

## Getting Started

When you first explore the project, you'll find some sample slides that demonstrate how slides are built in this project.\
You have the option to use these as templates or completely discard them to begin anew.\
\
**🚨Check out this guide** to create **your first slide🚨** -> https://flutter-show-docs.vercel.app/docs/quick_start \
Once the application is running, use the _**M key**_ to open the **Menu**!

## General Information

FlutterShow consists of two main packages: `fluttershow_base` and `fluttershow_keynote`:

- [fluttershow_base](https://github.com/lucas-goldner/fluttershow_base) contains most of the pre-built widgets that are used in `fluttershow_keynote`, but can also be used to make custom slides.
- [fluttershow_keynote](https://github.com/lucas-goldner/fluttershow_keynote) is currently the default package and implements all basic slides with variations of the popular presentation software Keynote.
- FlutterShow⚡️ uses riverpod hooks for state management, providing a simple and quick experience for managing your state.
- FlutterShow⚡️ is designed to be easily expandable and customizable according to your preferences. You can switch libraries like `intl` to `easy_localizations` or use `fluttergen` for asset organization.

Any more questions?\
Check the docs 📄: https://flutter-show-docs.vercel.app/#/ \
Or ask them in our discord 🗣️: https://discord.gg/xC6wtbzZnP

## Awesome features 😱

### Menu

The **Menu** _(Open using **M key**)_: Toggle dark/light mode depending on the location you are presenting at or quickly jump between your slides.

![Menu](https://raw.githubusercontent.com/lucas-goldner/FlutterShow/main/docs/images/menu.png)

### Animations

Most slides and prebuilt widgets can be animated for a smoother experience. Simply pass an `animationIndex` parameter to enable animation on the desired slide or widget.
In addition to animating individual slides and widgets, you can also animate the transitions between slides. An example of slide transition animation can be found in [`lib/slides/03_motivation/view/motivation.dart`](lib/slides/03_motivation/view/motivation.dart) file.

### Code Display

Use the `Code Display` to present your beautiful code:

### Rebindable Keys

You can easily rebind your keys for actions like navigating to the next or previous slide and opening the menu. Simply edit the actions in [`lib/presentation/config/key_actions.dart`](lib/presentation/config/key_actions.dart).

### Toggle Cursor

Using the **O key** the mouse cursor can be hidden or shown again. Optionally it is possible to set a custom cursor as it can be seen here:

![Custom Cursor](https://raw.githubusercontent.com/lucas-goldner/FlutterShow/main/docs/images/custom_cursor.png)

## Talks using FlutterShow⚡️

## Team

Want to talk to us?

[![](https://dcbadge.vercel.app/api/server/xC6wtbzZnP)](https://discord.gg/xC6wtbzZnP)

Main author:

Lucas Goldner

[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/LucasGoldner)
[![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@lucas.goldner)
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/lucas-goldner)

Team:

Fré Dumazy\
[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/FresidentDumazy)
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/dumazy)

Sai Rajendra Immadi\
[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/immadisairaj)
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/immadisairaj)

FlutterShow

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README