Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve starter documentation with some examples #151

Open
wants to merge 1 commit into
base: 0.2
Choose a base branch
from
Open

Improve starter documentation with some examples #151

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 37 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,54 @@ Installation
------------

To create your Monofony-based application, first make sure you use PHP 7.2 or higher and have [Composer](https://packagist.org/) installed.
You can check these requirements with:
```bash
$ php --version
PHP 7.2.31 (cli) (built: May 29 2020 02:00:47) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.2.0, Copyright (c) 1998-2018 Zend Technologies
with Xdebug v2.9.1, Copyright (c) 2002-2020, by Derick Rethans
with Zend OPcache v7.2.31, Copyright (c) 1999-2018, by Zend Technologies
$ type composer
composer is hashed (/usr/local/bin/composer)
```

Install Monofony using composer
Then, create your Monofony-based project using composer.
For example, to create a project `my-new-project` run:
```bash
export SYMFONY_ENDPOINT=https://flex.symfony.com/r/github.com/symfony/recipes-contrib/871
composer create-project monofony/skeleton acme
composer create-project monofony/skeleton my-new-project
```

The end of the composer should give you some hints on what to do next.
At least, be sure to have a running database, and check the .env targets it properly.
For example, if you want a development docker container for that purpose:
```bash
$ docker run --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root -d mysql:5.6.47
$ netstat -an | grep 3306
tcp46 0 0 *.3306 *.* LISTEN
$ mysql -h 127.0.0.1 -uroot -p
# check you can properly login with password root, and exit mysql

$ grep DATABASE_URL my-new-project/.env
DATABASE_URL=mysql://root:[email protected]:3306/db_name?serverVersion=5.7
```

Install project :
Then, install and start project :
```bash
$ cd my-new-project
$ bin/console app:install
$ yarn install && yarn build (or "yarn dev" for development usage)
$ symfony server:start --no-tls
```

Your project should be available at http://127.0.0.1:8000

You should be able to login in to http://127.0.0.1:8000/admin/login with the admin you provided during the
`bin/console app:install` command (or the default admin of the demo below if you run it with the
no-interaction flag via `bin/console app:install -n`


Documentation
-------------

Expand Down