README

Disclaimer: this is an unofficial fork of Jetstream meant to be a community-driven adding additional options for projects scaffolded using Jetstream. This package is published separately from the official Jetstream package and meant to be used as a drop in replaced. I'll do my best to keep this fork updated, but PRs are always welcome!

Introduction

Typestream is Laravel Jetstream fork beautifully designed application scaffolding for Laravel. Jetstream provides the perfect starting point for your next Laravel application and includes login, registration, email verification, two-factor authentication, session management, API support via Laravel Sanctum, and optional team management.

Jetstream is designed using Tailwind CSS and offers your choice of Livewire or Inertia scaffolding. For those using the Inertia stack, you may optionally choose to use TypeScript as well.

Additionally for those choosing Inertia, you may also choose to install ESLint pre-configured with the popular Vue-based rules provided by Vue community member Anthony Fu.

Official Documentation

Documentation for this fork of Jetstream is the same as written on the Jetstream website. See the section below for instructions on getting started with the fork in place of the official package.

Getting Started

This fork adds additional scaffolding for Jetstream with all options in the documentation fully intact. As of now, the only enhancement is the addition of TypeScript support for the Inertia stack. To get started with this fork, simply scaffold a new Laravel project

## Scaffold a new bare bones Laravel project
composer create-project laravel/laravel example-app

cd example-app

## IMPORTANT: install this fork _instead_ of the official laravel/jetstream package
composer require joeymckenzie/jetstream

Refer to the official documentation for the available artisan install commands. Typestream offers the additional --typescript option for Inertia stacks:

## Installs Vue-based Inertia with TypeScript support, though all other options also work
php artisan jetstream:install inertia --typescript

Contributing

Thank you for considering contributing to Jetstream! You can read the contribution guide here.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

Laravel Jetstream is open-sourced software licensed under the MIT license.

joeymckenzie / typestream

Maintainers

Details