Skip to content

Commit c585833

Browse files
committed
Improve readme
1 parent 8dcef1b commit c585833

File tree

2 files changed

+28
-21
lines changed

2 files changed

+28
-21
lines changed

README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,47 @@
1-
21
<p align="center">
32
<img alt="Frameworks a lot - he's one!" src="logo.png">
43
</p>
54

65
[![Build Status](https://travis-ci.org/Maxlab/stacker.svg?branch=master)](https://travis-ci.org/Maxlab/stacker)
76
[![License](https://poser.pugx.org/maxlab/stacker/license)](https://packagist.org/packages/maxlab/stacker)
8-
[![Gratipay User](https://img.shields.io/gratipay/user/maxlab.svg)](https://gratipay.com/~maxlab)
9-
[![Bountysource](https://img.shields.io/bountysource/team/maxlabstacker/activity.svg)](https://www.bountysource.com/teams/maxlabstacker)
10-
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Q477VJVB9STGS)
117

8+
## Introduction
129
#### Frameworks a lot - he's one!
1310
Environment for local web development, ready for use. Run Symfony, Laravel, Yii, and other frameworks easy! You can also run native php.
14-
15-
#### Video demos (RU)
16-
- [Presentation](https://youtu.be/qVqzYMczuwM)
17-
- [PhpStorm + Xdebug + Stacker = profit!](https://youtu.be/RYnRamdZJ-Q)
18-
- [Console, Composer, Gulp, Npm, Gem, Bower](https://youtu.be/WBFMs35ucfk)
19-
- [Run Symfony, Laravel and native PHP scripts](https://youtu.be/TONMezpUqkc)
20-
2111
#### General goals
2212
- Frameworks a lot - he's one!
2313
- Everything is easy, nothing to migrate
2414
- Quickly start of developing locally
2515
- No overhead on settings! Сopied project and run
2616
- Zoo under a Docker, let the host mashine remains clean!
17+
#### Video demos (RU)
18+
- [Presentation](https://youtu.be/qVqzYMczuwM)
19+
- [PhpStorm + Xdebug + Stacker = profit!](https://youtu.be/RYnRamdZJ-Q)
20+
- [Console, Composer, Gulp, Npm, Gem, Bower](https://youtu.be/WBFMs35ucfk)
21+
- [Run Symfony, Laravel and native PHP scripts](https://youtu.be/TONMezpUqkc)
22+
#### Why stacker?
23+
Stacker - This is a local environment for web development with everything you need. What is its benefit?
24+
1. You do not need to manually configure the web server and add to the hosts, just cloned it and immediately launched it in the browser. It looks so https://youtu.be/42BemUfK5-4
25+
2. Inside, there is already everything that is needed in 90% of all cases. And if not, we will add it for you)
26+
3. For you, there is a super zsh console with autocomplete and everything you need. Video with presentation https://youtu.be/N7HpPoNcaA4?list=PLD8VGB8i9TYha8YOd-deV6bX5hZco0ZGy
27+
4. There is an autocompletion for Symfony and Laravel commands out of the box. For example, la5 and a double tab, will output a list of commands for which you can "walk" with arrows to select them
28+
5. It is faster analogs, the same homestead is just a turtle compared to it
29+
6. There is a video course https://www.youtube.com/playlist?list=PLD8VGB8i9TYha8YOd-deV6bX5hZco0ZGy
30+
7. Friendly author, in case there are questions or suggestions
31+
8. Based on Docker. Wherever you can install Docker, you can install and Stacker
32+
9. It is very simple to expand. The process of adding your own images with a couple of lines in docker-compose.yml
33+
10. Just try it!
34+
2735

2836
## Requirements
2937
- Install [Docker](https://docs.docker.com/)
3038
- Install [Docker Compose](https://docs.docker.com/compose/install/) > 1.8.0
31-
- Clone this project:
39+
40+
## Installation
41+
#### Clone this project:
3242
```sh
3343
$ git clone [email protected]:Maxlab/stacker.git
3444
```
35-
36-
## Usage
37-
3845
#### Run in Stacker directory
3946
```sh
4047
# make ./workspace folder and make a symbolic link to your folder with all your projects
@@ -50,7 +57,6 @@ $ service docker restart
5057
- add `127.0.0.1 test.project.dev` to your hosts file `/etc/hosts`
5158
- add `127.0.0.1 mail.dev` to your hosts file `/etc/hosts`
5259
- Then open http://test.php.dev/ in your browser
53-
5460
- [Examples](https://youtu.be/42BemUfK5-4)
5561

5662
#### For SSH
@@ -191,3 +197,9 @@ $ stacker console # for enter to console
191197
$ stacker logs <cont_name> -f # for logs stream container
192198
$ stacker build && stacker down && stacker up && stacker ps # for full rebuild
193199
```
200+
201+
## Support project
202+
You can support the project in several ways:
203+
1. Becoming a sponsor - If you are interested in becoming a sponsor, please visit the Stacker [Patreon page](http://patreon.com/maxlab)
204+
2. Posting review - You can support the project by posting reviews in their social networks. Send a link to the review and we'll post it here!
205+
3. Buy a beer - [![Gratipay User](https://img.shields.io/gratipay/user/maxlab.svg)](https://gratipay.com/~maxlab) [![Bountysource](https://img.shields.io/bountysource/team/maxlabstacker/activity.svg)](https://www.bountysource.com/teams/maxlabstacker) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Q477VJVB9STGS)

composer.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,5 @@
1515
],
1616
"require": {
1717
"docker-compose": ">1.8.0"
18-
},
19-
"extra": {
20-
"branch-alias": {
21-
"dev-master": "0.6-dev"
22-
}
2318
}
2419
}

0 commit comments

Comments
 (0)