Skip to content

Commit

Permalink
Merry Christmas Everyone 🎄🎅
Browse files Browse the repository at this point in the history
  • Loading branch information
ipimpat committed Dec 25, 2022
0 parents commit 16c9373
Show file tree
Hide file tree
Showing 71 changed files with 4,444 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

/.idea
/node_modules
/vendor
.phpunit.result.cache
composer.lock
mix-manifest.json
npm-debug.log
package-lock.json
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Kim Henriksen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
94 changes: 94 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Bootstream

[![Latest Stable Version](https://poser.pugx.org/ipimpat/bootstream/v)](https://packagist.org/packages/ipimpat/bootstream)
[![Total Downloads](https://poser.pugx.org/ipimpat/bootstream/downloads)](https://packagist.org/packages/ipimpat/bootstream)
[![License](https://poser.pugx.org/ipimpat/bootstream/license)](https://packagist.org/packages/ipimpat/bootstream)

## Description

Bootstream is a Laravel 9 package that replaces Laravel Jetstream's TailwindCSS based Inertia stack with a Bootstrap 5.2 based Inertia stack.

## Table of Content

* [Installation](#installation)
+ [Install Jetstream with Inertia](#install-jetstream-with-inertia)
+ [Install Bootstream](#install-bootstream)
+ [Finalizing the Installation](#finalizing-the-installation)
* [Testing](#testing)
* [License](#license)

## Installation

This package only supports Jetstream with [Inertia](https://jetstream.laravel.com/2.x/stacks/inertia.html).

> It is important you install and configure [Laravel Jetstream](https://github.com/laravel/jetstream) with the Inertia stack before performing the installation.
You are highly encouraged to read through the entire documentation of [Jetstream](https://jetstream.laravel.com)
before beginning your Bootstream project.

### Install Jetstream with Inertia

You may use Composer to install Jetstream into your new Laravel project:

```bash
composer require laravel/jetstream
```

After installing the Jetstream package, you may use the `jetstream:install` command to install Jetstream With Inertia:

```bash
php artisan jetstream:install inertia

php artisan jetstream:install inertia --teams
```

### Install Bootstream

You may use Composer to install Bootstream into your new Laravel project as dev dependency:

```bash
composer require ipimpat/bootstream --dev
```

The Bootstream install command are very similar to that of Jetstream.

In addition, you may use the `--teams` switch to install team assets just like you would in Jetstream:

```bash
php artisan bootstream:install

php artisan bootstream:install --teams
```

### Finalizing the Installation

After installing Bootstream, install and build your NPM dependencies:

```
npm install
npm run build
php artisan migrate
```

## Testing

Run the tests with:

```bash
vendor/bin/phpunit
```

or

```bash
composer tests
```

## Credit

- [Jetstrap](https://github.com/nascent-africa/jetstrap)
- [Laravel Jetstream](https://jetstream.laravel.com)

## License

Bootstream is open-sourced software licensed under the [MIT license](https://github.com/ipimpat/bootstream/blob/master/LICENSE).
53 changes: 53 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
{
"name": "ipimpat/bootstream",
"description": "A Laravel 9 package that replaces Laravel Jetstream's TailwindCSS based Inertia stack with a Bootstrap 5.2 based Inertia stack.",
"keywords": ["laravel", "bootstrap", "jetstream", "inertiajs", "vuejs"],
"license": "MIT",
"support": {
"issues": "https://github.com/ipimpat/bootstream/issues",
"source": "https://github.com/ipimpat/bootstream"
},
"authors": [
{
"name": "Kim Henriksen",
"email": "[email protected]",
"role": "Developer"
}
],
"require": {
"php": "^8.0",
"illuminate/support": "^9.0"
},
"require-dev": {
"inertiajs/inertia-laravel": "^0.6.3",
"laravel/jetstream": "^2.13",
"orchestra/testbench": "^7.17",
"phpunit/phpunit": "^9.5"
},
"autoload": {
"psr-4": {
"Ipimpat\\Bootstream\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Ipimpat\\Bootstream\\Tests\\": "tests/"
}
},
"extra": {
"laravel": {
"providers": [
"Ipimpat\\Bootstream\\BootstreamServiceProvider"
]
}
},
"config": {
"sort-packages": true
},
"minimum-stability": "dev",
"prefer-stable": true,
"scripts": {
"tests": "vendor/bin/phpunit",
"testsVerbose": "@tests -vvv"
}
}
21 changes: 21 additions & 0 deletions licenses/Jetstrap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 nascent-africa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
21 changes: 21 additions & 0 deletions licenses/Jetstream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) Taylor Otwell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
12 changes: 12 additions & 0 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
bootstrap="vendor/autoload.php"
colors="true"
>
<testsuites>
<testsuite name="tests">
<directory suffix="Test.php">./tests</directory>
</testsuite>
</testsuites>
</phpunit>
32 changes: 32 additions & 0 deletions src/BootstreamServiceProvider.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

namespace Ipimpat\Bootstream;

use Illuminate\Support\ServiceProvider;

class BootstreamServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*
* @return void
*/
public function register(): void
{
//
}

/**
* Bootstrap any application services.
*
* @return void
*/
public function boot(): void
{
if ($this->app->runningInConsole()) {
$this->commands([
Console\InstallCommand::class,
]);
}
}
}
Loading

0 comments on commit 16c9373

Please sign in to comment.