Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bluzphp/skeleton

Bluz skeleton application
https://github.com/bluzphp/skeleton

framework php

Last synced: 3 months ago
JSON representation

Bluz skeleton application

Host: GitHub
URL: https://github.com/bluzphp/skeleton
Owner: bluzphp
License: mit
Created: 2012-11-06T10:57:30.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2022-04-15T08:33:20.000Z (almost 3 years ago)
Last Synced: 2024-04-27T01:40:59.607Z (10 months ago)
Topics: framework, php
Language: PHP
Homepage:
Size: 9.25 MB
Stars: 41
Watchers: 19
Forks: 27
Open Issues: 14
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        Bluz, a lightweight PHP Framework

=================================

Easy to setup, easy to use. Skeleton application

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bluzphp/main)

## Achievements

[![PHP >= 7.3+](https://img.shields.io/packagist/php-v/bluzphp/skeleton.svg?style=flat)](https://php.net/)

[![Latest Stable Version](https://img.shields.io/packagist/v/bluzphp/skeleton.svg?label=version&style=flat)](https://packagist.org/packages/bluzphp/skeleton)

[![Build Status](https://img.shields.io/travis/bluzphp/skeleton/master.svg?style=flat)](https://travis-ci.com/bluzphp/skeleton)

[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/bluzphp/skeleton.svg?style=flat)](https://scrutinizer-ci.com/g/bluzphp/skeleton/)

[![Coverage Status](https://img.shields.io/coveralls/bluzphp/skeleton/master.svg?style=flat)](https://coveralls.io/r/bluzphp/skeleton?branch=master)

[![Total Downloads](https://img.shields.io/packagist/dt/bluzphp/skeleton.svg?style=flat)](https://packagist.org/packages/bluzphp/skeleton)

[![License](https://img.shields.io/packagist/l/bluzphp/skeleton.svg?style=flat)](https://packagist.org/packages/bluzphp/skeleton)

## Installation

Bluz works with PHP 7.0 or later and MySQL 5.4 or later (please check [requirements](https://github.com/bluzphp/skeleton/wiki/Requirements))

### I.a. From composer

Download `composer.phar`, it's easy:

```bash

curl -s https://getcomposer.org/installer | php

```

Run `create-project` command (replace `%path%` ;):

```bash

php composer.phar create-project bluzphp/skeleton %path% --stability=dev

```

### I.b. From repository

Get Bluz skeleton source files from GitHub repository:

```bash

git clone git://github.com/bluzphp/skeleton.git %path%

```

Download `composer.phar` to the project folder:

```bash

cd %path%

curl -s https://getcomposer.org/installer | php

```

Install composer dependencies with the following command:

```bash

php composer.phar install

```

### I.c. With PhpStorm

For install you need any web-server (for Windows) and PhpStorm. dows) и PhpStorm.

Create project in PhpStorm:

1. File -> New project;

2. Set the project name and location;

3. In a Project type field choose Composer project;

4. Check that radiobutton is set opposite "Download composer.phar from getcomposer.org", type in a search field "bluzphp/skeleton", select this package in Available packages window and click OK.

5. After that file composer.phar and all dependencies will be loaded. 

### II. Configuration

Edit your configuration's files `/path/to/application/configs/dev/*.php` (configuration for development environment).

> I think you need to change only `db.php` for first run

### III. Setup database

To run the migrations, execute the command:

```bash

/path/to/vendor/bin/bluzman db:migrate

```

To fill database with data example, execute the command:

```bash

/path/to/vendor/bin/bluzman db:seed:run

```

### IV.a. Run built-in web-server

You can run internal PHP web-server with simple console tool:

```bash

/path/to/vendor/bin/bluzman server:start --host[="..."] --port[="..."]

```

### IV.b. Use Apache

Or create symlink to Apache document root (required FollowSymlinks option):

```bash

# for Linux

ln -s /path/to/public /path/to/web

```

```bash

# for Windows

mklink /D /path/to/web path/to/public

```

## Usage

You can create models, controllers and views with [Bluzman](https://github.com/bluzphp/bluzman) console tool, 

or following *old school style*:

### Model

Model consists from two classes `Table` and `Row`:

```php

 Users\Table::findRow($id)

    ];

};

```

### View

View is native:

```php

=$user->login?>

```

## Documentation

* [Framework wiki](https://github.com/bluzphp/framework/wiki)

* [Skeleton wiki](https://github.com/bluzphp/skeleton/wiki)

* [Bluzman docs](https://github.com/bluzphp/bluzman)

## Demo

* [Bluz Demo](http://bluz.demo.php.nixdev.co)

## License

The project is developed by [NIX](http://nixsolutions.com) PHP team and distributed under [MIT LICENSE](https://raw.github.com/bluzphp/skeleton/master/LICENSE.md)

[NIX](http://nixsolutions.com) has OEM License of [Redactor](http://imperavi.com/redactor/).

Full text of Redactor License you can read at http://imperavi.com/redactor/license/

## Vendors

* [jQuery](https://github.com/jquery/jquery/)

* [RequireJS](http://requirejs.org/)

* [Twitter Bootstrap](http://getbootstrap.com/)