Opensmarty Starter PHP Framework
Tested and used in production by Opensmarty Inc., (*1)
![Software License][ico-license], (*2)
Opensmarty Starter is a PHP framework for quick building Web Apps and Restful APIs, with modern design pattern foundation., (*3)
It is built on top of popular Laravel 5.5 framework, Vue.js 2.4, Restful API, Repository Design, OAuth2, JWT, Unit Tests, isolated front-end and back-end layer., (*4)
Note: You may notice that .idea folder is included. No worries, any conflict files in .idea folder has been ignored as in .gitignore file., (*5)
Opensmarty Starter is born for 3 reasons:
-
Quick web application starter without the need to build from scratch using Laravel., (*6)
-
Isolated front-end and back-end layer using Restful API., (*7)
-
Introducing modern design pattern, which have a better foundation when starting, for PHP projects., (*8)
See In Action
Frontend with Vue.js and displaying data via Restful API, (*9)
Email: opensmarty@163.com, (*10)
Password: Abc12345, (*11)
See In Video
Watch the video tutorial from below., (*12)
YouTube: https://youtu.be/6_lxJNX0Qe0, (*13)
Framework Overview
Opensmarty Starter is suitable for Restful API oriented projects., (*14)
The Restful APIs as a backend layer which provide simple unified interfaces for frontend: Web and Mobile apps., (*15)
It utilized Laravel Passport to authenticate protected resources., (*16)
It also provides Unit Tests for API testing and framework testing., (*17)
It is shipped with Angulr Theme and features in every part that you can easily reference., (*18)
It is fully utilised Repository Design pattern., (*19)
Out-of-box Components
If you are not familiar with any of these packages, you are recommended to get to know them as they are really helpful when you needed.
Framework
- Laravel 5.5 laravel/framework
- Laravel IDE Helper barryvdh/laravel-ide-helper
- Clockwork itsgoingd/clockwork
- Laravel 5 log viewer rap2hpoutre/laravel-log-viewer, (*20)
Foundation
- Redis predis/predis
- GuzzleHTTP guzzlehttp/guzzle
- HTTP Status lukasoppermann/http-status, (*21)
Core
- Restful API dingo/api
- L5 Repository prettus/l5-repository
- Fractal thephpleague/fractal
- Laravel Validation prettus/laravel-validation
- Intervention Image intervention/image
- Intervention Image Cache intervention/imagecache
- Rest API Client opensmarty/rest-api-client
- Opensmarty Image Service opensmarty/opensmarty-image, (*22)
Authentication
- Laravel Passport laravel/passport, (*23)
Theme
- Angulr theme with Bootstrap and jQuery support. For Demo: Angular version and HTML version., (*24)
Please buy a license if you use this in your project., (*25)
Frontend
- Vue.js Reactive Components for Modern Web Interfaces, (*26)
Get Started
Make sure you have already installed PHP 7.1 and composer., (*27)
You can get started either option A or B:, (*28)
A. Get started via composer
Under working folder, run the command:, (*29)
composer create-project --prefer-dist opensmarty/opensmarty-starter opensmarty-starter
A.1. Add to a git repository (When Needed)
Change https://github.com/username/repository-name.git to your own git repository address., (*30)
cd opensmarty-starter
git init
git add .
git commit -m 'Initial commit'
git remote add origin https://github.com/username/repository-name.git
git push -u origin master
B. Get started via cloning repository
Clone this project to your working folder and open the directory:, (*31)
git clone https://github.com/opensmarty/opensmarty-starter
B.1. Add to a git repository (When Needed)
Change https://github.com/username/repository-name.git to your own git repository address., (*32)
cd opensmarty-starter
rm -rf .git
git init
git add .
git commit -m 'Initial commit'
git remote add origin https://github.com/username/repository-name.git
git push -u origin master
Installation
Development Requirements
- PHP: >=7.1
- MySQL: >=5.7
- SQLite extension
- Laravel 5: https://laravel.com/docs/5.5/installation
- Yarn: https://yarnpkg.com/
- NodeJS: https://nodejs.org/
- Bower: https://bower.io/
Install Essentials
Open opensmarty-starter folder (Optional, run only when you are not inside the project root folder), (*33)
cd opensmarty-starter
All these commands should be executed under the root of opensmarty-starter project, (*34)
Install composer dependencies, (*35)
composer install
Install npm dependencies using Yarn dependency management (suggested), (*36)
Note: This command should be outside homestead environment. Also, you can still use npm install if you want., (*37)
yarn install
Install bower dependencies, (*38)
bower install
Set-up Laravel, after these commands, please change .env file for your own environment settings, (*39)
sudo cp .env.example .env
sudo chmod -R 777 storage bootstrap/cache
php artisan key:generate
Database & Seeding
You need to create a Database e.g. opensmarty_starter with Encoding utf8mb4 and Collation utf8mb4_unicode_ci., (*40)
MySQL Query:, (*41)
CREATE DATABASE `opensmarty_starter` DEFAULT CHARACTER SET = `utf8mb4` DEFAULT COLLATE = `utf8mb4_unicode_ci`;
Change database config in .env file to the match the database that your just created., (*42)
After having database configuration setup, you can now do migrations and seeding., (*43)
php artisan migrate
php artisan db:seed
Install Laravel Passport with encryption keys to generate secure access tokens., (*44)
php artisan passport:install
When deploy in server:, (*45)
sudo chown www-data:www-data storage/oauth-*.key
sudo chmod 600 storage/oauth-*.key
Ready to go
Until this point, you should be able to visit the home page., (*46)
For example, if you have set the domain: http://opensmarty-starter.app/., (*47)
Just visit: http://opensmarty-starter.app/, (*48)
It should prompt you for login, use:, (*49)
opensmarty@163.com
Abc12345
You are free to change the seeding account information from the file: database/seeds/UsersTableSeeder.php, (*50)
You are done. Yeah!, (*51)
Explore and start to build on top of it., (*52)
Development Process and Flow
Essential Knowledge
You will need to know, read and understand fowllowing before you can start build on top of these., (*53)
We recommend use PHPStorm IDE to build and develop your projects., (*54)
Namespace
The default namespace for app/ folder is Opensmarty., (*55)
It is NOT recommended to change the namespace, if you are not familiar with namespace of Opensmarty Starter as the Opensmarty namespace is used heavily within whole project., (*56)
However, you can still change it if you know how what you are doing, because some namespaces required manually changing., (*57)
To change namespace to your preference:, (*58)
php artisan app:namespace YourApp
BaseClass
In order to ultise all features provided by Opensmarty Starter, you should extended the Class from BaseClass (if there has one), e.g. BasePresenter, BaseController, etc., (*59)
Models
All models are located under app/Models/ folder., (*60)
User Model under folder app/Models/Foundation/ is created by default with primary key user_id, you should not change this class heavily because it is used almost everywhere within whole project. You can use global function auth_user() to access currently logged in user., (*61)
Every model should extend Opensmarty/Models/BaseModel which has a observer Opensmarty/Observers/BaseModelObserver that you can utilize all model events within the Model, e.g. onCreating, onCreated, onUpdating, onDeleting, etc., (*62)
When creating new model, you should do it using command to auto generate related Repository classes., (*63)
php artisan starter:entity Post
Web Http
All Web related files are located under app/Http/ folder., (*64)
Web Routes are defined in file routes/web.php, (*65)
Web Controllers are defined in folder app/Http/Controllers/, (*66)
Restful API
All API related files are located under app/Api/ folder., (*67)
API Routes are defined in file routes/api.php, (*68)
API Controllers are defined in folder app/Api/Controllers/, (*69)
When you create APIs, you need to test them before you can use it. You should test all APIs using Unit Tests provided or create new Unit Tests. Not recommended to test using Browser or Postman, etc., (*70)
Repository Pattern
All repository related files are located under app/ with specific types as parent folders., (*71)
Repositories: app/Repositories/, (*72)
Repositories Eloquent: app/Repositories/Eloquent/, (*73)
Repositories Interface: app/Repositories/Interfaces/, (*74)
Repositories Criteria: app/Repositories/Criteria/, (*75)
Presenters: app/Presenters/, (*76)
Transformers: app/Transformers/, (*77)
Validators: app/Validators/, (*78)
Resouces
Angulr Styles and Scripts: resources/assets/angulr/, (*79)
Angulr with Blade views: resources/views/angulr/, (*80)
Vuejs: resources/assets/js/, (*81)
Less styles: resources/assets/less/app.less, (*82)
Sass styles: resources/assets/sass/app.scss, (*83)
When made changes in scripts, styles, you will need to run the command., (*84)
In development, run:, (*85)
npm run dev
In development and watching assets for changes, run:, (*86)
npm run watch
In production, run:, (*87)
npm run production
When you changed theme files, run:, (*88)
npm run theme
API and Unit Tests
Note:, (*89)
You may need to change the local service configs under dev environment from config/rest-client.php to fit your local development configurations., (*90)
Also change the value of API_TEST_CLIENT_SECRET in .env file to the secret value of Password Grant Client record in oauth_clients table., (*91)
Unit Tests: tests/, (*92)
API Unit Tests: tests/Api/, (*93)
Debug and Clockwork
View all requests and request information from file storage/clockwork.sqlite, (*94)
OAuth Web Support
OAuth HTTP URL: http://opensmarty-starter.app/console/oauth, (*95)
Web Log Viewer
Log Viewer HTTP URL: http://opensmarty-starter.app/console/logs, (*96)
Database
We recommend to use migrations for database structure and seeding.
Directly changing from database or not follow migrations is strongly NOT recommended., (*97)
Flow of creating database migrations:
-
Create a migration file (Auto generated when use php artisan starter:entity), under folder database/migrations/, (*98)
-
Add essential columns to migration file (Auto generated when use php artisan starter:entity):, (*99)
You are recommended to use tablename_id format as primary incremental key, for example, for table posts, you need to use post_id, and when this become a foreign key, you should keep the same name in other table post_id., (*100)
$table->increments('post_id');
You are also recommended to use the user_id field in all tables, for example, use user_id as staff id instead of staff_id in company_staffs table. If there are no meaning for user_id in certain tables, you should still put user_id field in case for future usage. So, you need to use it smartly to fit your table scenarios accordingly. And, similarly, you may optionally want to add a related_user_id field to indicate certain record is related to a user depends on your own needs., (*101)
The following columns are always required by BaseModel:, (*102)
$table->unsignedInteger('user_id')->index();
$table->unsignedInteger('created_by')->nullable();
$table->timestamp('created_at')->nullable();
$table->ipAddress('created_ip')->nullable();
$table->unsignedInteger('updated_by')->nullable();
$table->timestamp('updated_at')->nullable();
$table->ipAddress('updated_ip')->nullable();
And remove timestamps():, (*103)
// $table->timestamps();
Finally, the table blue print should be looks like, e.g. in posts table:, (*104)
$table->increments('post_id');
$table->unsignedInteger('user_id')->index();
// Adding more table related fields here...
$table->unsignedInteger('created_by')->nullable();
$table->timestamp('created_at')->nullable();
$table->ipAddress('created_ip')->nullable();
$table->unsignedInteger('updated_by')->nullable();
$table->timestamp('updated_at')->nullable();
$table->ipAddress('updated_ip')->nullable();
-
Add factory support, under file database/factories/ModelFactory.php, (*105)
-
Create seeding support, under folder database/seeds/, (*106)
Refresh Database Migrations and Seeding
When you added or changed to migrations or seeds files, or you just simply want to refresh everything in database:, (*107)
php artisan migrate:refresh --seed
License
The Opensmarty Starter framework is open-sourced software licensed under the MIT license., (*108)
Wallogit.com
