Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rakshazi/slim-skeleton
Slim 3 skeleton project for https://github.com/rakshazi/slim-suit
https://github.com/rakshazi/slim-skeleton
docker docker-compose skeleton slim slim-framework slim-suit twig
Last synced: about 1 month ago
JSON representation
Slim 3 skeleton project for https://github.com/rakshazi/slim-suit
- Host: GitHub
- URL: https://github.com/rakshazi/slim-skeleton
- Owner: rakshazi
- Created: 2017-02-14T10:01:54.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-25T10:28:00.000Z (over 7 years ago)
- Last Synced: 2024-10-16T18:24:02.860Z (3 months ago)
- Topics: docker, docker-compose, skeleton, slim, slim-framework, slim-suit, twig
- Language: PHP
- Homepage:
- Size: 45.9 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Install
## Project
```bash
composer create-project rakshazi/slim-skeleton
```
## Docker
> **NOTE**: this docker image is production ready and works only with SSL for production and with SSL and without it for dev env.
1. Change `your.site` domain in `docker-compose.yml` and `docker-compose-prod.yml` to your domain
4. Run docker-compose:
```bash
#For development
docker-compose up
#For production
docker-compose -f docker-compose-prod.yml up -d
```
Composer dependencies, migrations, and DB will be created automaticaly
## Docker - which image to choose?
### `rakshazi/slim-skeleton` (Dockerfile)
> **@deprecated**: that file will be removed in future, but you still can use it
Must be used for development only. Includes composer with dependencies in it. `composer update` runs on container start
### `quay.io/rakshazi/slim-skeleton` (Dockerfile.quay)
Full-featured image **without composer** and its dependencies. `composer update` should be run on build stage.
Example of Dockerfile for your usage (if you dont want to build base image yourself):
```Dockerfile
FROM composer/composer:alpine
COPY ./ /app
RUN composer update --ignore-platform-reqs --no-ansi --no-dev \
--no-interaction --no-progress --no-scripts --optimize-autoloader \
-d /app
FROM quay.io/rakshazi/slim-skeleton
MAINTAINER Your Name
COPY --from=0 /app/ /var/www/
```
# Documentation
### Backend
* App - **Slim Framework**: [slimframework.com/docs/](https://www.slimframework.com/docs/) + [rakshazi/slim-suit](https://github.com/rakshazi/slim-suit) + [akrabat/rka-slim-session-middleware](https://github.com/akrabat/rka-slim-session-middleware)
* ORM - **Medoo**: [medoo.in/doc](https://medoo.in/doc)
* Migrations, seeds - **Phinx**: [docs.phinx.org](http://docs.phinx.org/en/latest/)
* Exception handling - **Sentry.io**: [docs.sentry.io](https://docs.sentry.io)
* Session storage - **Redis**: [redis.io](https://redis.io)
### Frontend
* Rendering engine - **Twig**: [twig.sensiolabs.org](https://twig.sensiolabs.org/) + [slim/flash](https://github.com/slimphp/Slim-Flash) + [kanellov/slim-twig-flash](https://github.com/kanellov/slim-twig-flash)
* Framework - **Twitter Bootstrap**: [getbootstrap.com](https://getbootstrap.com/getting-started/) + [jQuery](https://jquery.com)