* basic usage documentation
This commit is contained in:
parent
8f414f40b8
commit
1de77564b5
37
README.md
Normal file
37
README.md
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
# TaurusTv
|
||||||
|
|
||||||
|
## Tools used for development
|
||||||
|
|
||||||
|
- [php7.1](http://php.net) - [installation on ELX](https://www.colinodell.com/blog/2016-12/installing-php-7-1)
|
||||||
|
- [composer](https://getcomposer.org/download/)
|
||||||
|
- [deployer](https://deployer.org/download)
|
||||||
|
- [phpStorm](https://www.jetbrains.com/phpstorm/download/)
|
||||||
|
|
||||||
|
Install the latest versions, add them to your $PATH.
|
||||||
|
|
||||||
|
## Prepare for development
|
||||||
|
The app needs a copy of the `*.dist` files under the config folder without the `.dist` extension filled with the correct information.
|
||||||
|
These files are moved to a `shared/` folder on deployment and simlinks are created pointing to them, so their content is retained on subsequent deploys.
|
||||||
|
|
||||||
|
### Install required node packages
|
||||||
|
```bash
|
||||||
|
# Inside your project root
|
||||||
|
composer install
|
||||||
|
```
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
|
||||||
|
Run `dep deploy` in the project root, to deploy the application to `vasgyuro.tsp`. The application will automatically reload on the TV when a new version is deployed.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
### Development server
|
||||||
|
|
||||||
|
Run `composer serve` for a dev server. Navigate to `http://localhost:8080/`.
|
||||||
|
|
||||||
|
### Code scaffolding
|
||||||
|
|
||||||
|
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|module`.
|
||||||
|
|
||||||
|
### Further help
|
||||||
|
|
||||||
|
To get more help on ZF3-Expressive go check out [ZF Expressive](http://zendframework.github.io/zend-expressive/).
|
||||||
Loading…
x
Reference in New Issue
Block a user