Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miracuthbert/saas-boilerplate
SaaS boilerplate built in Laravel, Bootstrap 4 and VueJs.
https://github.com/miracuthbert/saas-boilerplate
api boilerplate laravel restful-api saas saas-boilerplate subscription
Last synced: 5 days ago
JSON representation
SaaS boilerplate built in Laravel, Bootstrap 4 and VueJs.
- Host: GitHub
- URL: https://github.com/miracuthbert/saas-boilerplate
- Owner: miracuthbert
- Created: 2018-03-14T13:55:02.000Z (over 6 years ago)
- Default Branch: 2.x
- Last Pushed: 2023-08-27T15:13:55.000Z (about 1 year ago)
- Last Synced: 2024-08-01T15:30:50.915Z (3 months ago)
- Topics: api, boilerplate, laravel, restful-api, saas, saas-boilerplate, subscription
- Language: PHP
- Homepage:
- Size: 3.22 MB
- Stars: 350
- Watchers: 15
- Forks: 136
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# saas-boilerplate
This is a SaaS boilerplate built on top of the Laravel framework.
Built to provide developers with a template to kickoff their SaaS application,
without the hustle for repetitive tasks such as user account setup, subscriptions
and role management.
## folder structure
Inspired by domain-driven approach.
Laravel's main `app` folder is restructured to: `App`, `Domain` and `Http`.
### outline of app folder
- App
- Console
- Controllers
- Exceptions
- Providers
- Traits
- TwoFactor
- ViewComposers
- Domain
- Account
- Auth
- Events
- Listeners
- Mail
- Rules
- Projects
- Subscriptions
- Teams
- Users
- Models
- Filters
- Observers
- Http
- Account
- Controllers
- Requests
- Auth
- Controllers
- Requests
- Middleware
- Subscriptions
- Teams
- Users
- Policies
- Resources
## features
- Authentication
- Login / Registration
- Email Activation
- Two Factor Login (only when enabled)
- Subscription with Stripe
- User plans
- Team plans
- Account (User Account)
- Profile Update
- Change Password
- Two Factor Authentication
- Subscription
- Cancel Subscription
- Resume Subscription
- Swap Plan
- Update Card
- API Tokens
- Single Database Multi-tenancy
- Admin
- User Management
- Create Users (and assign role)
- Manage User Roles
- Role & Permissions Management
- Developer Panel
- Manage OAuth Clients
- Manage Personal Access Tokens
- Other features
- Filtering (extendable)
- API access (starter template)
*Note: Some features may be subjected to change. Other features may not be listed
since they are under development or do not qualify as a standard / main SaaS feature.
Some common features will not be listed as well.*
## Installation
1. Fork, clone or download this repository.
2. Run `composer install` if its the initial setup or `composer update`.
3. Setup your environment keys in .env
(*If .env does not exist then copy / rename .env.example as .env*)
4. Run `php artisan migrate` for initial tables setup.
5. __Optional:__ Run `php artisan db:seed --class=RoleTableSeeder` to set the initial
roles and permissions, then follow `step 7` below to assign a user the initial permissions and roles.
6. __Optional:__ To create a `root` admin;
Run `php artisan role:assign [email protected] admin-root`.
Substitute `[email protected]` with an existing user email. `admin-root` is the __default root Admin role__.
__Note:__ You must follow `step 5` above first to setup the root admin.
## Usage
### Generating different files in app folder
#### Channel Make Command
php artisan make:channel \SAAS\App\Broadcasting\{name}
#### Console Make Command
php artisan make:console \SAAS\App\Console\Commands\{name}
#### Exception Make Command
php artisan make:exception \SAAS\App\Exceptions\{name}
#### Job Make Command
php artisan make:job \SAAS\Domain\{namespace}\Jobs\{name}
#### Event Make Command
php artisan make:event \SAAS\Domain\{namespace}\Events\{name}
#### Listener Make Command
php artisan make:listener \SAAS\Domain\{namespace}\Listeners\{name}
#### Mail Make Command
php artisan make:mail \SAAS\Domain\{namespace}\Mail\{name}
#### Model Make Command
php artisan make:model \SAAS\Domain\{namespace}\Models\{name}
#### Notification Make Command
php artisan make:notification \SAAS\Domain\{namespace}\Notifications\{name}
#### Policy Make Command
php artisan make:policy \SAAS\Http\{namespace}\Policies\{name}
#### Rule Make Command
php artisan make:rule \SAAS\Domain\{namespace}\Rules\{name}
__Note__: Some files can be placed in the `app/App` folder if they are intended to be used globally
```cli
php artisan make:{command} \SAAS\App\{namespace}\{name}
```
### Custom Commands
1. __Admin: *Assign user a role*__
Use `php artisan role:assign `:
`` is the user's email and `` is the *slug of the role* you wish to assign the user.
### Force HTTPS
When pushing the project to a platform or production environment,
assets or urls may be broken if the platform enforces HTTPS.
*To enable urls to use HTTPS:*
Set `FORCE_HTTPS` variable in `.env` file to `true`.
By default `FORCE_HTTPS` is `false`.
```Note:``` If `FORCE_HTTPS` does not exist in your `.env`,
just add it as a new variable and assign a boolean value `true` or `false`.
This dynamically tells Laravel to force urls to use HTTPS which is especially
handy in fixing or preventing broken assets urls.
### Single Database Multi-tenancy
See [miracuthbert/laravel-multi-tenancy](https://github.com/miracuthbert/laravel-multi-tenancy)
#### Model setup
To start using single databse multi-tenancy call `ForTenants` trait on a model
```php
use Miracuthbert\Multitenancy\Traits\ForTenants;
class Project extends Model
{
use ForTenants;
}
```
#### Tenants CRUD Operations
Once you have setup the model as show above. `Just call CRUD operations directly`.
`Tenant` relationships are handled automatically.
```php
$projects = Project::create([
'name' => 'Project 1'
]);
$projects = Project::get();
```
#### Normal CRUD Operations
To perform CRUD operations on models with `ForTenants` trait can be done by
adding `withoutForTenants` scope when fetching records associated with that model.
```php
$projects = Project::withoutForTenants()->get();
```
*__This comes in handy for example in: admin or moderation operations__*
#### Routing
All `tenant` routes are under the routes folder in the `tenant.php` file.
Note: *__Tenant routes follow the same structure as other routes__*
`The main reason we place all tenant routes separately is to handle route binding and
its much easier to know which routes are for tenants.`
## libraries & packages
- Main
- PHP (>=8)
- Laravel (Minimal 9)
- Laravel Cashier (can be switched)
- UI (can be switched)
- Bootstrap (v4)
- Font awesome
- Simple Line Icons
- jQuery
- VueJs
- Development
- nodejs
- npm
## services
- Stripe (payment gateway)
- Authy by Twilio (two factor authentication)
## Changes
- `Roles and Permissions`: See [miracuthbert/laravel-roles](https://github.com/miracuthbert/laravel-roles)
- `Multi-tenancy`: See [miracuthbert/laravel-multi-tenancy](https://github.com/miracuthbert/laravel-multi-tenancy)
## Security Vulnerabilities
If you discover a security vulnerability, please send an e-mail to Cuthbert Mirambo via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.