Skip to content
This repository has been archived by the owner on Aug 9, 2022. It is now read-only.

Commit

Permalink
#1 README.md + setup docker
Browse files Browse the repository at this point in the history
  • Loading branch information
mathieu-ducrot committed Jun 23, 2021
1 parent 51c8760 commit db1374f
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
23 changes: 23 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.DEFAULT_GOAL := help
.PHONY: help
help:
@grep -E '(^[a-zA-Z_-]+:.*?##.*$$)|(^##)' ./Makefile | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[34m%-20s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[34m##/[33m/'

##
## Docker
## -------
.PHONY: up
up: ## Start the project stack with docker
docker-compose up

.PHONY: down
down: ## Kill the project stack with docker
docker-compose down

.PHONY: ps
ps: ## List containers from project
docker-compose ps

.PHONY: ssh
ssh: ## Access to the php container in interactive mode
docker exec -it --user=dev smartbooster-parameterbundle-php bash
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# SMARTBOOSTER - Parameter bundle

## Installation

### Add the bundle as dependency with Composer

``` bash
composer require smartbooster/parameter-bundle
```

## What's inside !

Provide an easy way to administrate your app parameters through each environment with the following tools :

- A **configuration template to define all parameters** that need to exist in your application with their default value
- A **Command to use on CD to generate missing parameters**
- A **Parameter Entity** to store your parameters in database
- An **Admin** to easily edit the value of your parameters and more data related to them

## Contributing

Pull requests are welcome.

Thanks to [everyone who has contributed](https://github.com/smartbooster/parameter-bundle/contributors) already.
10 changes: 10 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: '3'

services:
php:
container_name: smartbooster-parameterbundle-php
image: smartbooster/php-fpm:builder
ports:
- "9000:9000"
volumes:
- ./:/var/www

0 comments on commit db1374f

Please # to comment.