Skip to content

Commit

Permalink
chore: add installing steps
Browse files Browse the repository at this point in the history
  • Loading branch information
pferreirafabricio authored May 2, 2021
1 parent 29d27ff commit 322ee57
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 322ee57

Please sign in to comment.