Skip to content

Commit

Permalink
Updated default port in README, documented the demo code that is ship…
Browse files Browse the repository at this point in the history
…ped with the app (#15)

* Updated default port in README.md, added notes about the demo code that is shipped in this app

* Tweaked wording
  • Loading branch information
davidbyoung authored Feb 2, 2021
1 parent 6f2b0a6 commit 260e9c4
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ composer create-project aphiria/app --prefer-dist --stability dev

## Running Locally

You can run your app locally (defaults to http://localhost):
You can run your app locally (defaults to http://localhost:8080):

```php
php aphiria app:serve
```

## Removing Demo Code
## Demo

This app comes with an extremely simple demo that can store and retrieve users from local file storage. It should not be used in production - it is simply a demo of some Aphiria features. The demo routes can be found as PHP attributes in _src/Demo/Api/Controllers/UserController.php_.

### Removing Demo Code

To remove the built-in demo code, simply delete the _src/Demo_ and _tests/Integration/Demo_ directories, and remove the `DemoModule` from _src/App.php_.

Expand Down

0 comments on commit 260e9c4

Please sign in to comment.