Nova Framework 4.1-dev

• What is the Nova Framework?
• Requirements
• Installation
  • Recommended
  • Manual
• Documentation
• Contributing
  • Issue Tracker
  • Pull Requests
  • Code Style
• License

What is the Nova Framework?

Nova Framework is a PHP 5.5 MVC system. It's designed to be lightweight and modular, allowing developers to build better and easy to maintain code with PHP.

The base framework comes with a range of helper classes.

Requirements

The framework requirements are limited.

• PHP 5.5 or greater.
• Apache Web Server or equivalent with mod rewrite support.
• IIS with URL Rewrite module installed - http://www.iis.net/downloads/microsoft/url-rewrite

The following PHP extensions should be enabled:

• Fileinfo (edit php.ini and uncomment php_fileinfo.dll or use php selector within cpanel if available.)
• OpenSSL
• INTL

Note: Although a database is not required, if a database is to be used, the system is designed to work with a MySQL database using PDO.

Installation

This framework was designed and is strongly recommended to be installed above the document root directory, with it pointing to the public folder.

Additionally, installing in a sub-directory, on a production server, will introduce severe security issues.

Recommended

The framework is located on Packagist.

You can install the framework from a terminal by using:

composer create-project nova-framework/bare-app foldername -s dev

The foldername is the desired folder to be created.

Note: You can install the full application variant from a terminal by using:

composer create-project nova-framework/app foldername -s dev

Manual

• Place the contents of public into your public folder (.htaccess and index.php)
• Navigate to your project in a terminal and type composer install to initiate the composer installation.
• Edit public/.htaccess to set the rewritebase if running on a sub folder, otherwise a single / will do.
• Edit app/Config.example.php and change the SITEURL and DIR constants. The DIR path is relative to the project url for example / for on the root or /foldername/ when in a folder. Also change other options as desired. Rename file to Config.php
• Set a 32 character ENCRYPT_KEY by using the CLI tool. You can do this by typing php nova make:key in your command line / console. Alternatively, you can use the following tool: http://jeffreybarke.net/tools/codeigniter-encryption-key-generator/

Note: For additional installation instructions, for example; setting up a Virtualhost (Recommended for Local Development), Nginx or IIS with URL Rewrite, please visit the Github Wiki.

Documentation

Full docs & tutorials are available on novaframework.com and the Github Wiki.

Offline docs are available in PDF, EPUB and MOBI formats on Leanpub.

Screencasts are available on Novacasts.

Contributing

Issue Tracker

You can find outstanding issues on the GitHub Issue Tracker.

Pull Requests

• Each pull request should contain only one new feature or improvement.
• Pull requests should be submitted to the correct version branch ie 3.0/master

Code Style

All pull requests must use the PSR-2 code style.

• Code MUST use the PSR-1 code style.
• Code MUST use 4 spaces for indenting, not tabs.
• There MUST NOT be a hard limit on line length; the soft limit MUST be 120 characters; lines SHOULD be 80 characters or less.
• There MUST be one blank line after the namespace declaration, and there MUST be one blank line after the block of use declarations.
• Opening braces for classes MUST go on the next line, and closing braces MUST go on the next line after the body.
• Opening braces for methods MUST go on the next line, and closing braces MUST go on the next line after the body.
• Visibility MUST be declared on all properties and methods; abstract and final MUST be declared before the visibility; static MUST be declared after the visibility.
• Control structure keywords MUST have one space after them; method and function calls MUST NOT.
• Opening braces for control structures MUST go on the same line, and closing braces MUST go on the next line after the body.
• Opening parentheses for control structures MUST NOT have a space after them, and closing parentheses for control structures MUST NOT have a space before.

License

The Nova Framework is under the MIT License, you can view the license here.