From 322ee5711dd6cc768d479c357df6adec84837292 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabr=C3=ADcio=20Pinto=20Ferreira?= Date: Sat, 1 May 2021 21:23:41 -0300 Subject: [PATCH] chore: add installing steps --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a61705a..d4a8663 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,17 @@ This project is a simple PHP API structure for use in quick and small projects w - [PHP](https://www.php.net/) - [CoffeCode Router](https://github.com/robsonvleite/router) - [MySQL](https://www.mysql.com/) +- [Nginx](https://www.nginx.com/) - [Docker](https://www.docker.com/) ## :running_man: Installing and Running - `Coming soon...` + 1. Clone this repository `git clone https://github.com/pferreirafabricio/php-pirateCave.git`; + 2. Enter in the project's folder: `cd php-pirateCave` + 3. Build de app image: `docker-compose build app` + 4. Start the containers: `docker-compose up -d` + 6. Install project's dependencies: `docker-compose exec app composer install` + 7. Init GrumPHP pre-commit (optional): `docker-compose exec app php ./vendor/bin/grumphp git:pre-commit` + 8. Finally you can visit [`127.0.0.1:8000/`](http://127.0.0.1:8000/) from your browser 😃 ## :recycle: Contribute 1. Fork this repository;