Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/awurth/slim3
Slim Framework 3 Skeleton Application
https://github.com/awurth/slim3
boilerplate eloquent framework monolog php skeleton slim starter twig
Last synced: 3 months ago
JSON representation
Slim Framework 3 Skeleton Application
- Host: GitHub
- URL: https://github.com/awurth/slim3
- Owner: awurth
- License: mit
- Created: 2016-10-16T08:31:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-05T18:01:37.000Z (about 5 years ago)
- Last Synced: 2024-02-15T10:47:08.110Z (12 months ago)
- Topics: boilerplate, eloquent, framework, monolog, php, skeleton, slim, starter, twig
- Language: PHP
- Homepage:
- Size: 493 KB
- Stars: 70
- Watchers: 7
- Forks: 26
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Slim 3 application skeleton
[](https://insight.sensiolabs.com/projects/297ce2e4-166d-45d5-8d11-ae0651a8c7ac) [](https://scrutinizer-ci.com/g/awurth/Slim/?branch=master)
This is an app skeleton for the Slim PHP Micro-Framework to get started quickly
## Features
- [Eloquent ORM](https://github.com/illuminate/database)
- Flash messages ([Slim Flash](https://github.com/slimphp/Slim-Flash))
- CSRF protection ([Slim Csrf](https://github.com/slimphp/Slim-Csrf)) with fields rendering with a twig function
- Authentication ([Sentinel](https://github.com/cartalyst/sentinel))
- Validation ([Respect](https://github.com/Respect/Validation) + [Slim Validation](https://github.com/awurth/slim-validation))
- Twig templating engine [Slim Twig View](https://github.com/slimphp/Twig-View) with cache and debug
- CSS Framework [Bootstrap 4](https://github.com/twbs/bootstrap)
- [Webpack](https://webpack.js.org) [Encore](https://symfony.com/doc/current/frontend.html#webpack-encore) for *SASS* and *JS* files compilation and minification
- Helpers for assets management, redirections, ...
- Logs ([Monolog](https://github.com/Seldaek/monolog))
- Dotenv configuration
- Console commands for updating the database schema or creating users
- Functionnal tests base ([PHPUnit](https://github.com/sebastianbergmann/phpunit))
For more information, check out the project's [wiki](https://github.com/awurth/Slim/wiki).
## Installation
### Create the project using Composer
``` bash
$ composer create-project awurth/slim-base [project-name]
```
### Setup environment variables
Copy `.env` to a `.env.local` file and change the values to your needs. This file is ignored by Git so all developers working on the project can have their own configuration.
### Download client-side libraries
``` bash
$ yarn
```
or if you prefer to use npm
``` bash
$ npm install
```
### Webpack
This skeleton uses Webpack to manage assets. The CSS and Javascript files are located in `assets/`, so you have to use Webpack after creating your project to generate the minified files in `public/`, which will be ignored by Git.
#### Generate assets
If you just want to generate the default CSS and JS that comes with this skeleton, run the following command
``` bash
$ yarn build
```
or
``` bash
$ npm run build
```
If you want to run a watcher and begin coding
``` bash
$ yarn watch
```
### Setup cache files permissions
The skeleton uses a cache system for Twig templates and the Monolog library for logging, so you have to make sure that PHP has write permissions on the `var/cache/` and `var/log/` directories.
### Update your database schema
First, create a database with the name you set in the `.env*` file. Then you can create the tables by running this command:
``` bash
$ php bin/console db
```