Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hotwired-laravel/hotstream

Hotstream is a Hotwired application Starter Kit for Laravel.
https://github.com/hotwired-laravel/hotstream

Last synced: 3 months ago
JSON representation

Hotstream is a Hotwired application Starter Kit for Laravel.

Awesome Lists containing this project

README

        

Logo Hotstream



Latest Stable Version


License

**Attention: This project is under development and is not production-ready yet.**

Hotstream is an application Starter Kit for Laravel. It's heavily inspired by [Laravel Jetstream](https://github.com/laravel/jetstream), but modified to better work as a [Hotwired](https://hotwired.dev/) application.

It comes with [Turbo.js](https://turbo.hotwired.dev/), [Stimulus](https://stimulus.hotwired.dev/), [Importmap Laravel](https://github.com/tonysm/importmap-laravel), and [TailwindCSS Laravel](https://github.com/tonysm/tailwindcss-laravel). And features a Node-less frontend setup.

## Installation

You can install the package via composer:

```bash
composer require hotwired-laravel/hotstream
```

You can install Hotstream by running:

```bash
php artisan hostream:install
```

Alternatively, you can opt-in to include Teams:

```bash
php artisan hostream:install --teams
```

Then, migrate:

```bash
php artisan migrate
```

Since we're using [Importmap Laravel](https://github.com/tonysm/importmap-laravel), you'll need to create the symlink to map the JS folder to your `public/` folder by running (remember to run that inside Sail if you're using that):

```bash
php artisan storage:link
```

Next, to finish the [TailwindCSS Laravel](https://github.com/tonysm/tailwindcss-laravel) installation, you'll need to download the Tailwind CLI and compile your assets at least once:

```bash
php artisan tailwindcss:download
php artisan tailwindcss:build
```

Done!

## Documentation

Documentation for Hotstream can be found on the [Hotstream section of the Turbo Laravel website](https://hotstream.turbo-laravel.com).

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Tony Messias](https://github.com/tonysm)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.