Skip to content

Commit

Permalink
Readme, move info to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mruz committed Jul 12, 2014
1 parent 45d3bc5 commit 1935feb
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 66 deletions.
67 changes: 2 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,7 @@
# base-app 2.0

##### The base application in PhalconPHP
Use this application as a way to quick start any new project.
See working [base-app](http://base-app.mruz.pl), user/pass: user user, admin admin.
Use this application as a way to quick start any new project. See working [base-app](http://base-app.mruz.pl), user/pass: user user, admin admin.
#####Migration to 2.0 in progress, demo may not work properly!
***
### Features:
* Bootstrap file
* Config file
* [CLI](https://github.com/mruz/base-app/wiki/CLI) and Console file
* HMVC support
* [Volt](http://docs.phalconphp.com/en/latest/reference/volt.html), Markdown templates
* Frontend/Backend/Cli/Documentation modules
* Environment
* _development_ - display debug, always compile template files, always minify assets
* _testing_ - log debug, only checks for changes in the children templates, checks for changes and minify assets
* _staging_ - log debug, notify admin, only checks for changes in the children templates, checks for changes and minify assets
* _production_ - log debug, notify admin, don't check for differences, don't create missing files, compiled and minified files must exist before!
* Library
* [Arr](https://github.com/mruz/base-app/wiki/Arr)
* [Auth](https://github.com/mruz/base-app/wiki/Auth)
* [Email](https://github.com/mruz/base-app/wiki/Email)
* [I18n](https://github.com/mruz/base-app/wiki/I18n)
* Markdown
* [Tool](https://github.com/mruz/base-app/wiki/Tool)
* Payment
* [PayPal](http://www.paypal.com)
* [dotpay](http://www.dotpay.pl)
* User
* Models
* Auth schema mysql
* Twitter Bootstrap 3.2.0

### Configuration:
1. Set *base_uri* and other settings in */app/common/config/config.ini*
2. Use */auth-schema-mysql.sql* to create required tables
3. Make sure that these directories are writable by the web server:
* `/app/common/logs`
* `/app/common/cache`
* `/public/min`

### Requirements:
* Phalcon **2.0.0** (temporarily works on 1.3.0)

### Links:
* [Phalcon PHP](https://phalconphp.com)
* [Base-app](https://github.com/mruz/base-app)
* [Demo](http://base-app.mruz.pl)
* [Twitter Bootstrap](http://getbootstrap.com)

### Example volt usage:
##### auth in views
```php
{% if auth.logged_in() %}
{{ auth.get_user().username }}
{% endif %}
```

##### easy translation with __() function
```php
{% if auth.logged_in('admin') %}
{{ __('Hello :user', [':user' : auth.get_user().username]) }}
{% endif %}
```

##### use static classes in volt
```php
{{ dump('string', 1, 2.5, TRUE, NULL, ['key': 'value'], users__findFirst(1)) }}
```
[Documentation](http://base-app.mruz.pl/doc)
8 changes: 7 additions & 1 deletion app/documentation/views/index/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@
```

##### use static classes in volt
```django
{% set user = users__findFirst(1) %}
{{ user.username }}
```

##### debug variables
```php
{{ dump('string', 1, 2.5, TRUE, NULL, ['key': 'value'], users__findFirst(1)) }}
{{ dump('string', 1, 2.5, TRUE, NULL, ['key': 'value'], user) }}
```

0 comments on commit 1935feb

Please sign in to comment.