Skip to content

Commit

Permalink
Merge pull request #297 from loic425/update-readme-for-documentation
Browse files Browse the repository at this point in the history
Update readme for documentation
  • Loading branch information
loic425 committed Jan 22, 2021
2 parents 8e25e50 + d07c9a3 commit 67b8f87
Showing 1 changed file with 2 additions and 74 deletions.
76 changes: 2 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,87 +9,15 @@
</a>
</h1>

Installation
------------

To create your Monofony-based application, first make sure you use PHP 7.2 or higher and have [Composer](https://packagist.org/) installed.

Install Monofony using composer
```bash
export SYMFONY_ENDPOINT=https://flex.symfony.com/r/github.com/symfony/recipes-contrib/1022
composer create-project monofony/skeleton acme
```

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

### Api

The Monofony skeleton is built with the admin panel only.
You can install our API package to use our default endpoints using `Api Platform`

![alt text](https://github.com/Monofony/Monofony/raw/0.x/docs/_images/api.png "Logo Title Text 1")

Uncomment `$syliusResources` binding on `config/services.yaml`

```yaml
# config/services.yaml
services:
# ...
_defaults:
# ...
bind:
# ...
$syliusResources: '%sylius.resources%' # for api
```

And execute the following commands:

```bash
export SYMFONY_ENDPOINT=https://flex.symfony.com/r/github.com/symfony/recipes-contrib/1022
composer require monofony/api-pack
```

### Front

To build a frontend, you can use our front-pack with default features:
* login
* register
* forgotten password
* user profile

You can install it using the following commands:

```bash
export SYMFONY_ENDPOINT=https://flex.symfony.com/r/github.com/symfony/recipes-contrib/1022
composer require monofony/front-pack
```

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

Documentation is available at [https://monofony.readthedocs.io/en/latest/](https://monofony.readthedocs.io/en/latest/).
Documentation is available at [docs.monofony.com](https://docs.monofony.com).

Demo
----

A Demo is available.

**Admin**
- Username: admin@example.com
- Password: admin

[View Monofony admin](https://monofony.mobizel.com/admin)

**Front**
- Username: customer@example.com
- Password: password

[View Monofony front](https://monofony.mobizel.com)
New demo coming soon...

Community
---------
Expand Down

0 comments on commit 67b8f87

Please sign in to comment.