Skip to content

Commit

Permalink
1.0 release under Gearbox Solutions
Browse files Browse the repository at this point in the history
  • Loading branch information
Smef committed Feb 14, 2023
1 parent 4ece836 commit bd49fdf
Show file tree
Hide file tree
Showing 14 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 Blue Feather Group, LLC.
Copyright (c) 2022 Gearbox Solutions, LLC.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ This package is designed to allow you to exclusively use a FileMaker database an

## Support

This package is built and maintained by [Blue Feather](https://www.bluefeathergroup.com/). We build fantastic web apps with technologies like Laravel, Vue, React, and Node. If you would like assistance building your own web app, either using this package or other technologies, please [contact us](https://www.bluefeathergroup.com/contact/) for a free introductory consultation to discuss your project.
This package is built and maintained by [Gearbox Solutions](https://gearboxgo.com/). We build fantastic web apps with technologies like Laravel, Vue, React, and Node. If you would like assistance building your own web app, either using this package or other technologies, please [contact us](https://gearboxgo.com/) for a free introductory consultation to discuss your project.

## Prepare your FileMaker database

### Quickstart with an example FileMaker database
If you just want to see an example of Jetstream working with FileMaker you can unzip and use the `Jetstream-FileMaker.fmp12` file included in the `dist` folder as an example data source ([or download here](https://github.com/BlueFeatherGroup/Jetstream-FileMaker/raw/main/dist/Jetstream-FileMaker.fmp12.zip)). This file has been configured with the minimum necessary fields to work with Jetstream and already has layouts ready for accessing through the Data API. You can host this file on your FileMaker Server and use it as a testing ground to see Laravel Jetstream running using a FileMaker database as a data source.
If you just want to see an example of Jetstream working with FileMaker you can unzip and use the `Jetstream-FileMaker.fmp12` file included in the `dist` folder as an example data source ([or download here](https://github.com/gearbox-solutions/Jetstream-FileMaker/blob/main/dist/Jetstream-FileMaker.fmp12.zip?raw=true)). This file has been configured with the minimum necessary fields to work with Jetstream and already has layouts ready for accessing through the Data API. You can host this file on your FileMaker Server and use it as a testing ground to see Laravel Jetstream running using a FileMaker database as a data source.

Otherwise, read the directions below for how to configure your existing FileMaker database to work with Jetstream. The example file is a great reference for configuring your own database.

Expand All @@ -25,7 +25,7 @@ You will need the following tables:
* PasswordReset
* PersonalAccessToken

These tables must also have the minimum required fields to support the features of the Jetstream starter kit. The required tables and fields for your FileMaker database can be found in the `Jetstream-FileMaker.fmp12` file included in the `dist` folder of this package ([or download here](https://github.com/BlueFeatherGroup/Jetstream-FileMaker/raw/main/dist/Jetstream-FileMaker.fmp12.zip)). You can either copy these tables/fields to your database, rename your existing fields, or use the [Eloquent-FileMaker field mapping feature](https://github.com/BlueFeatherGroup/eloquent-filemaker) to map your existing fields to these expected field names.
These tables must also have the minimum required fields to support the features of the Jetstream starter kit. The required tables and fields for your FileMaker database can be found in the `Jetstream-FileMaker.fmp12` file included in the `dist` folder of this package ([or download here](https://github.com/gearbox-solutions/Jetstream-FileMaker/blob/main/dist/Jetstream-FileMaker.fmp12.zip?raw=true)). You can either copy these tables/fields to your database, rename your existing fields, or use the [Eloquent-FileMaker field mapping feature](https://github.com/gearbox-solutions/eloquent-filemaker) to map your existing fields to these expected field names.

### Set up layouts for Data API access
The The FileMaker Data API allows access to your tables through layouts in your FileMaker database. Only fields which are on the layouts accessed through the Data API are visible. This means that you MUST include all the fields you want to access through the data API on your layouts.
Expand All @@ -41,7 +41,7 @@ By default, Laravel looks for pluralized versions of each of the tables. If you

The example `Jetstream-FileMaker.fmp12` file has these prepared as a demonstration, so you can always look at that for reference.

If you don't want to use the pluralized table names Laravel will be searching for by default, the layout names used for the models can also be configured in each model file by setting the table name directly using the `$table` property. Do not include any configured table prefix, such as `web_` when setting table/layout names. You can refer to the [Laravel](https://laravel.com/docs/9.x/eloquent#table-names) and [Eloquent-FileMaker](https://github.com/BlueFeatherGroup/eloquent-filemaker#setting-a-layout) documentation for more information about layout and table naming.
If you don't want to use the pluralized table names Laravel will be searching for by default, the layout names used for the models can also be configured in each model file by setting the table name directly using the `$table` property. Do not include any configured table prefix, such as `web_` when setting table/layout names. You can refer to the [Laravel](https://laravel.com/docs/9.x/eloquent#table-names) and [Eloquent-FileMaker](https://github.com/gearbox-solutions/eloquent-filemaker) documentation for more information about layout and table naming.

## Install and configure Laravel
Laravel should be installed and configured as normal. You can follow the instructions on the [official Laravel website](https://laravel.com/docs/9.x/installation) to get started.
Expand All @@ -66,7 +66,7 @@ With the basic Jetstream installed it is now time to install the Jetstream-FileM

Install Jetstream-FileMaker using Composer
```
composer require bluefeather/jetstream-filemaker
composer require gearbox-solutions/jetstream-filemaker
```

Jetstream-FileMaker needs to update the default Jetstream `User` model and add new, custom models for `PasswordReset` and `PersonalAccessToken`. Install these models using artisan.
Expand All @@ -90,7 +90,7 @@ You also need to add a new FileMaker database connection to `config/database.php
'connections' => [
'filemaker' => [
'driver' => 'filemaker',
'host' => env('DB_HOST', 'bluefeathergroup.com'),
'host' => env('DB_HOST', 'fms.mycompany.com'),
'database' => env('DB_DATABASE', 'MyDatabaseName'),
'username' => env('DB_USERNAME', 'MyUsername'),
'password' => env('DB_PASSWORD', ''),
Expand Down
16 changes: 8 additions & 8 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
{
"name": "bluefeather/jetstream-filemaker",
"name": "gearbox-solutions/jetstream-filemaker",
"description": "An extension for Laravel Jetstream to make it work with FileMaker as a primary data source",
"license": "MIT",
"authors": [
{
"name": "David Nahodyl",
"email": "david@bluefeathergroup.com"
"email": "david@gearboxgo.com"
}
],
"require": {
"bluefeather/eloquent-filemaker": "^0.2.2",
"laravel/jetstream": "^2.10"
"gearbox-solutions/eloquent-filemaker": "^1.0",
"laravel/jetstream": "^2.16"
},
"autoload": {
"psr-4": {
"BlueFeather\\JetstreamFileMaker\\": "src/"
"GearboxSolutions\\JetstreamFileMaker\\": "src/"
}
},
"extra": {
"laravel": {
"providers": [
"BlueFeather\\JetstreamFileMaker\\Providers\\JetstreamFileMakerServiceProvider",
"BlueFeather\\JetstreamFileMaker\\Providers\\PasswordResetServiceProvider",
"BlueFeather\\JetstreamFileMaker\\Providers\\FileMakerValidationServiceProvider"
"GearboxSolutions\\JetstreamFileMaker\\Providers\\JetstreamFileMakerServiceProvider",
"GearboxSolutions\\JetstreamFileMaker\\Providers\\PasswordResetServiceProvider",
"GearboxSolutions\\JetstreamFileMaker\\Providers\\FileMakerValidationServiceProvider"
]
}
},
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/Passwords/DatabaseTokenRepository.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace BlueFeather\JetstreamFileMaker\Auth\Passwords;
namespace GearboxSolutions\JetstreamFileMaker\Auth\Passwords;

use App\Models\PasswordReset;
use Carbon\Carbon;
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/Passwords/PasswordBrokerManager.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace BlueFeather\JetstreamFileMaker\Auth\Passwords;
namespace GearboxSolutions\JetstreamFileMaker\Auth\Passwords;

class PasswordBrokerManager extends \Illuminate\Auth\Passwords\PasswordBrokerManager
{
Expand Down
2 changes: 1 addition & 1 deletion src/Console/InstallCommand.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace BlueFeather\JetstreamFileMaker\Console;
namespace GearboxSolutions\JetstreamFileMaker\Console;

use Illuminate\Console\Command;

Expand Down
2 changes: 1 addition & 1 deletion src/Providers/FileMakerUserProvider.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace BlueFeather\JetstreamFileMaker\Providers;
namespace GearboxSolutions\JetstreamFileMaker\Providers;

use Closure;
use Illuminate\Auth\EloquentUserProvider;
Expand Down
4 changes: 2 additions & 2 deletions src/Providers/FileMakerValidationServiceProvider.php
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?php

namespace BlueFeather\JetstreamFileMaker\Providers;
namespace GearboxSolutions\JetstreamFileMaker\Providers;


use BlueFeather\JetstreamFileMaker\Validation\DatabasePresenceVerifier;
use GearboxSolutions\JetstreamFileMaker\Validation\DatabasePresenceVerifier;
use Illuminate\Validation\ValidationServiceProvider;

class FileMakerValidationServiceProvider extends ValidationServiceProvider
Expand Down
4 changes: 2 additions & 2 deletions src/Providers/JetstreamFileMakerServiceProvider.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?php

namespace BlueFeather\JetstreamFileMaker\Providers;
namespace GearboxSolutions\JetstreamFileMaker\Providers;


use App\Models\User;
use BlueFeather\JetstreamFileMaker\Console\InstallCommand;
use GearboxSolutions\JetstreamFileMaker\Console\InstallCommand;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Hash;
Expand Down
4 changes: 2 additions & 2 deletions src/Providers/PasswordResetServiceProvider.php
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?php

namespace BlueFeather\JetstreamFileMaker\Providers;
namespace GearboxSolutions\JetstreamFileMaker\Providers;


use BlueFeather\JetstreamFileMaker\Auth\Passwords\PasswordBrokerManager;
use GearboxSolutions\JetstreamFileMaker\Auth\Passwords\PasswordBrokerManager;

class PasswordResetServiceProvider extends \Illuminate\Auth\Passwords\PasswordResetServiceProvider
{
Expand Down
2 changes: 1 addition & 1 deletion src/Validation/DatabasePresenceVerifier.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace BlueFeather\JetstreamFileMaker\Validation;
namespace GearboxSolutions\JetstreamFileMaker\Validation;

class DatabasePresenceVerifier extends \Illuminate\Validation\DatabasePresenceVerifier
{
Expand Down
2 changes: 1 addition & 1 deletion stubs/app/Models/PasswordReset.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace App\Models;

use BlueFeather\EloquentFileMaker\Database\Eloquent\FMModel;
use GearboxSolutions\EloquentFileMaker\Database\Eloquent\FMModel;

class PasswordReset extends FMModel
{
Expand Down
2 changes: 1 addition & 1 deletion stubs/app/Models/PersonalAccessToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace App\Models;

use BlueFeather\EloquentFileMaker\Database\Eloquent\FMModel;
use GearboxSolutions\EloquentFileMaker\Database\Eloquent\FMModel;
use Laravel\Sanctum\Contracts\HasAbilities;

class PersonalAccessToken extends FMModel implements HasAbilities
Expand Down
2 changes: 1 addition & 1 deletion stubs/app/Models/User.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace App\Models;

use BlueFeather\EloquentFileMaker\Database\Eloquent\FMModel;
use GearboxSolutions\EloquentFileMaker\Database\Eloquent\FMModel;
use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\MustVerifyEmail;
use Illuminate\Auth\Passwords\CanResetPassword;
Expand Down

0 comments on commit bd49fdf

Please sign in to comment.