PHPackages                             someline/someline-starter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. someline/someline-starter

ActiveProject[Framework](/categories/framework)

someline/someline-starter
=========================

Someline Starter is a PHP framework for quick building Web Apps and Restful APIs, with modern design pattern foundation.

v0.8.2(5y ago)8362.2k165[15 issues](https://github.com/someline/someline-starter/issues)[3 PRs](https://github.com/someline/someline-starter/pulls)MITPHPPHP ^7.1.3

Since Jun 14Pushed 5y ago53 watchersCompare

[ Source](https://github.com/someline/someline-starter)[ Packagist](https://packagist.org/packages/someline/someline-starter)[ RSS](/packages/someline-someline-starter/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (10)Versions (99)Used By (0)

Someline Starter PHP Framework
==============================

[](#someline-starter-php-framework)

Tested and used in production by **Someline Inc**.

[![Latest Version on Packagist](https://camo.githubusercontent.com/2eda76f8dc6e1e65ca0f323e40fbb79a9143f2fb9bd3a90be1a8280e9148721a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f736f6d656c696e652f736f6d656c696e652d737461727465722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/someline/someline-starter)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)

[Someline Starter](https://starter.someline.com/) is a PHP framework for quick building Web Apps and Restful APIs, with modern design pattern foundation.

It is built on top of popular `Laravel 5.8 framework`, `Vue.js 2.6`, `Restful API`, `Repository Design`, `OAuth2`, `JWT`, `Unit Tests`, isolated front-end and back-end layer.

Someline Starter is born for 3 reasons:
---------------------------------------

[](#someline-starter-is-born-for-3-reasons)

1. Quick web application starter without the need to build from scratch using Laravel.
2. Isolated front-end and back-end layer using Restful API.
3. Introducing modern design pattern, which have a better foundation when starting, for PHP projects.

See In Action
-------------

[](#see-in-action)

##### [Someline Starter Demo](https://starter.someline.com/)

[](#someline-starter-demo)

Frontend with Vue.js and displaying data via Restful API

Email:

Password: Abc12345

See In Video
------------

[](#see-in-video)

Watch the video tutorial from below.

YouTube: [https://youtu.be/6\_lxJNX0Qe0](https://youtu.be/6_lxJNX0Qe0)

Framework Overview
------------------

[](#framework-overview)

Someline Starter is suitable for Restful API oriented projects.

The Restful APIs as a backend layer which provide simple unified interfaces for frontend: Web and Mobile apps.

It utilized Laravel Passport to authenticate protected resources.

It also provides Unit Tests for API testing and framework testing.

It is shipped with Angulr Theme and features in every part that you can easily reference.

It is fully utilised Repository Design pattern.

Out-of-box Components
---------------------

[](#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.

[](#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.8 [laravel/framework](https://github.com/laravel/framework)
- Laravel IDE Helper [barryvdh/laravel-ide-helper](https://github.com/barryvdh/laravel-ide-helper)
- Clockwork [itsgoingd/clockwork](https://github.com/itsgoingd/clockwork)
- Laravel 5 log viewer [rap2hpoutre/laravel-log-viewer](https://github.com/rap2hpoutre/laravel-log-viewer)

*Foundation*

- Redis [predis/predis](https://github.com/nrk/predis)
- GuzzleHTTP [guzzlehttp/guzzle](https://github.com/guzzle/guzzle)
- HTTP Status [lukasoppermann/http-status](https://github.com/lukasoppermann/http-status)

*Core*

- Restful API [dingo/api](https://github.com/dingo/api)
- L5 Repository [prettus/l5-repository](https://github.com/andersao/l5-repository)
- Fractal [thephpleague/fractal](https://github.com/thephpleague/fractal)
- Laravel Validation [prettus/laravel-validation](https://github.com/andersao/laravel-validator)
- Intervention Image [intervention/image](http://image.intervention.io/)
- Intervention Image Cache [intervention/imagecache](https://github.com/Intervention/imagecache)
- Rest API Client [someline/rest-api-client](https://github.com/someline/rest-api-client)
- Someline Image Service [someline/someline-image](https://github.com/someline/someline-image)

*Authentication*

- Laravel Passport [laravel/passport](https://laravel.com/docs/5.8/passport)

*Theme*

- Angulr theme with Bootstrap and jQuery support. For Demo: [Angular version](http://flatfull.com/themes/angulr/angular/#/app/dashboard-v1) and [HTML version](http://flatfull.com/themes/angulr/html/).

    *Please [buy a license](http://themeforest.net/item/angulr-bootstrap-admin-web-app-with-angularjs/8437259?ref=Flatfull) if you use this in your project.*

*Frontend*

- [Vue.js](https://vuejs.org/) Reactive Components for Modern Web Interfaces

Get Started
-----------

[](#get-started)

*Make sure you have already installed PHP 7.1 and [composer](https://getcomposer.org/doc/00-intro.md).*

You can get started either option A or B:

### A. Get started via composer

[](#a-get-started-via-composer)

Under working folder, run the command:

```
composer create-project --prefer-dist someline/someline-starter someline-starter

```

#### A.1. Add to a git repository *(When Needed)*

[](#a1-add-to-a-git-repository-when-needed)

Change `https://github.com/username/repository-name.git` to your own git repository address.

```
cd someline-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

[](#b-get-started-via-cloning-repository)

Clone this project to your working folder and open the directory:

```
git clone https://github.com/someline/someline-starter

```

#### B.1. Add to a git repository *(When Needed)*

[](#b1-add-to-a-git-repository-when-needed)

Change `https://github.com/username/repository-name.git` to your own git repository address.

```
cd someline-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
------------

[](#installation)

### Development Requirements

[](#development-requirements)

- PHP: >=7.1.8
- MySQL: >=5.7
- SQLite extension
- Laravel 5:
- Yarn:
- NodeJS:
- Bower:

### Install Essentials

[](#install-essentials)

Open `someline-starter` folder *(Optional, run only when you are not inside the project root folder)*

```
cd someline-starter

```

*All these commands should be executed under the root of someline-starter project*

Install composer dependencies

```
composer install

```

Install npm dependencies using [Yarn](https://yarnpkg.com/) dependency management (suggested)

Note: This command should be **outside** homestead environment. Also, you can still use `npm install` if you want.

```
yarn install

```

Install bower dependencies

```
bower install

```

Set-up Laravel, after these commands, please change `.env` file for your own environment settings

```
sudo cp .env.example .env
sudo chmod -R 777 storage bootstrap/cache
php artisan key:generate

```

### Database & Seeding

[](#database--seeding)

You need to create a Database e.g. `someline_starter` with Encoding `utf8mb4` and Collation `utf8mb4_unicode_ci`.

`MySQL Query:`

```
CREATE DATABASE `someline_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.

After having database configuration setup, you can now do migrations and seeding.

```
php artisan migrate

php artisan db:seed

```

Install Laravel Passport with encryption keys to generate secure access tokens.

```
php artisan passport:install

```

When deploy in server:

```
sudo chown www-data:www-data storage/oauth-*.key
sudo chmod 600 storage/oauth-*.key

```

### Ready to go

[](#ready-to-go)

Until this point, you should be able to visit the home page.

For example, if you have set the domain: `http://someline-starter.sl/`.

Just visit:

It should prompt you for login, use:

```
libern@someline.com
Abc12345

```

You are free to change the seeding account information from the file: `database/seeds/UsersTableSeeder.php`

You are done. Yeah!

Explore and start to build on top of it.

Development Process and Flow
----------------------------

[](#development-process-and-flow)

### Essential Knowledge

[](#essential-knowledge)

You will need to know, read and understand fowllowing before you can start build on top of these.

- [Laravel Docs](https://laravel.com/docs/5.8/)
- [Restful API Best Practise](https://github.com/someline/someline-starter/wiki/10-Best-Practices-for-Better-RESTful-API)
- [dingo/api Guide](https://github.com/dingo/api/wiki)
- [Repository Pattern](https://bosnadev.com/2015/03/07/using-repository-pattern-in-laravel-5/?utm_source=prettus-l5-repository&utm_medium=readme&utm_campaign=prettus-l5-repository)
- [Repository Usage](https://github.com/andersao/l5-repository#usage)
- [Vue.js Guide](https://vuejs.org/guide/)

We recommend use [PHPStorm IDE](https://www.jetbrains.com/phpstorm/) to build and develop your projects.

#### Namespace

[](#namespace)

The default namespace for `app/` folder is `Someline`.

It is NOT recommended to change the namespace, if you are not familiar with namespace of Someline Starter as the `Someline` namespace is used heavily within whole project.

However, you can still change it if you know how what you are doing, because some namespaces required manually changing.

To change namespace to your preference:

```
php artisan app:namespace YourApp

```

#### BaseClass

[](#baseclass)

In order to utilize all features provided by Someline Starter, you should extended the Class from BaseClass (if there has one), e.g. `BasePresenter`, `BaseController`, etc.

#### Models

[](#models)

All models are located under `app/Models/` folder.

`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.

Every model should extend `Someline/Models/BaseModel` which has a observer `Someline/Observers/BaseModelObserver` that you can utilize all model events within the Model, e.g. `onCreating`, `onCreated`, `onUpdating`, `onDeleting`, etc.

When creating new model, you should do it using command to auto generate related Repository classes.

```
php artisan starter:entity Post

```

#### Web Http

[](#web-http)

All Web related files are located under `app/Http/` folder.

Web Routes are defined in file `routes/web.php`

Web Controllers are defined in folder `app/Http/Controllers/`

#### Restful API

[](#restful-api)

All API related files are located under `app/Api/` folder.

API Routes are defined in file `routes/api.php`

API Controllers are defined in folder `app/Api/Controllers/`

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.

#### Repository Pattern

[](#repository-pattern)

All repository related files are located under `app/` with specific types as parent folders.

Repositories: `app/Repositories/`

Repositories Eloquent: `app/Repositories/Eloquent/`

Repositories Interface: `app/Repositories/Interfaces/`

Repositories Criteria: `app/Repositories/Criteria/`

Presenters: `app/Presenters/`

Transformers: `app/Transformers/`

Validators: `app/Validators/`

#### Resouces

[](#resouces)

Angulr Styles and Scripts: `resources/assets/angulr/`

Angulr with Blade views: `resources/views/angulr/`

Vuejs: `resources/assets/js/`

Less styles: `resources/assets/less/app.less`

Sass styles: `resources/assets/sass/app.scss`

When made changes in scripts, styles, you will need to run the command.

In development, run:

```
yarn run dev

```

In development and watching assets for changes, run:

```
yarn run watch

```

In production, run:

```
yarn run production

```

When you changed theme files, run:

```
yarn run theme

```

#### API and Unit Tests

[](#api-and-unit-tests)

**Note:**

You may need to change the `local` service configs under `dev` environment from `config/rest-client.php` to fit your local development configurations.

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.

Unit Tests: `tests/`

API Unit Tests: `tests/Api/`

#### Debug and Clockwork

[](#debug-and-clockwork)

View all requests and request information from file `storage/clockwork.sqlite`

#### OAuth Web Support

[](#oauth-web-support)

OAuth HTTP URL: `http://someline-starter.sl/console/oauth`

#### Web Log Viewer

[](#web-log-viewer)

Log Viewer HTTP URL: `http://someline-starter.sl/console/logs`

#### Database

[](#database)

##### We recommend to use migrations for database structure and seeding.

[](#we-recommend-to-use-migrations-for-database-structure-and-seeding)

Directly changing from database or not follow migrations is strongly NOT recommended.

##### Flow of creating database migrations:

[](#flow-of-creating-database-migrations)

1. Create a migration file (Auto generated when use `php artisan starter:entity`), under folder `database/migrations/`
2. Add essential columns to migration file (Auto generated when use `php artisan starter:entity`):

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`.

```
$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.

The following columns are always required by `BaseModel`:

```
$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():

```
// $table->timestamps();

```

Finally, the table blue print should be looks like, e.g. in `posts` table:

```
$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();

```

3. Add factory support, under file `database/factories/ModelFactory.php`
4. Create seeding support, under folder `database/seeds/`

##### Refresh Database Migrations and Seeding

[](#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:

```
php artisan migrate:refresh --seed

```

License
-------

[](#license)

The Someline Starter framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity41

Moderate usage in the ecosystem

Community21

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~16 days

Recently: every ~164 days

Total

90

Last Release

2166d ago

PHP version history (4 changes)v0.0.1PHP >=5.5.9

v0.3.0PHP >=5.6.4

v0.6.1PHP >=7.0.0

v0.7.1PHP ^7.1.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/420da8717b27611ef8f553e2d143c4757e6e210fa56cc31fd6976b178956379b?d=identicon)[libern](/maintainers/libern)

---

Top Contributors

[![libern](https://avatars.githubusercontent.com/u/1830640?v=4)](https://github.com/libern "libern (313 commits)")

---

Tags

frameworklaravelsomeline-startersomeline

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/someline-someline-starter/health.svg)

```
[![Health](https://phpackages.com/badges/someline-someline-starter/health.svg)](https://phpackages.com/packages/someline-someline-starter)
```

###  Alternatives

[wanglelecc/laracms

The LaraCMS management system.

5874.0k](/packages/wanglelecc-laracms)[mpociot/botman-laravel-starter

BotMan Chatbot framework.

3335.4k](/packages/mpociot-botman-laravel-starter)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)