Skip to content

Commit

Permalink
Overall improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
LuckyCyborg committed Mar 19, 2018
1 parent 92afa51 commit 43e5d0b
Show file tree
Hide file tree
Showing 123 changed files with 2,340 additions and 1,400 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.idea
.vscode
# Framework specific
vendor/
composer.lock
Expand Down
1 change: 0 additions & 1 deletion .htaccess

This file was deleted.

34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
![Nova Framework](https://novaframework.com/themes/nova/assets/images/nova.png)
![Nova Framework](http://novaframework.com/app/templates/publicthemes/nova/images/nova.png)

# Nova Framework 4.0
# Nova Framework

[![Total Downloads](https://img.shields.io/packagist/dt/nova-framework/framework.svg)](https://packagist.org/packages/nova-framework/framework)
[![Dependency Status](https://www.versioneye.com/user/projects/554367f738331321e2000005/badge.svg)](https://www.versioneye.com/user/projects/554367f738331321e2000005)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nova-framework/framework/blob/master/LICENSE.txt)
[![GitHub stars](https://img.shields.io/github/stars/nova-framework/framework.svg)](https://github.com/nova-framework/framework/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/nova-framework/framework.svg)](https://github.com/nova-framework/framework/network)

[![Join the chat at https://gitter.im/nova-framework/framework](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/nova-framework/framework?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Join the general chat open to all at https://gitter.im/nova-framework/framework](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/nova-framework/framework/novausers)

- [What is the Nova Framework?](#what-is-the-nova-framework)
- [Requirements](#requirements)
Expand All @@ -24,15 +24,15 @@

## 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.
Nova Framework is a PHP 5.6 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](https://github.com/nova-framework/framework/tree/master/system/Helpers).

## Requirements

**The framework requirements are limited.**

- PHP 5.5 or greater.
- PHP 5.6 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](http://www.iis.net/downloads/microsoft/url-rewrite)

Expand All @@ -41,46 +41,38 @@ The base framework comes with a range of [helper classes](https://github.com/nov
- Fileinfo (edit php.ini and uncomment php_fileinfo.dll or use php selector within cpanel if available.)
- OpenSSL
- INTL
- MBString

> **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.
Additionally, installing in a sub-directory, on a production server, will introduce severe security issues. If there is no choice still place the framework files above the document root and have only index.php and .htacess from the public folder in the sub folder and adjust the paths accordingly.

#### Recommended
The framework is located on [Packagist](https://packagist.org/packages/nova-framework/app).
The framework is located on [Packagist](https://packagist.org/packages/nova-framework/framework).

You can install the framework from a terminal by using:

```
composer create-project nova-framework/app foldername -s dev
composer create-project nova-framework/framework foldername 3.* -s dev
```

The foldername is the desired folder to be created.


> **Note:** You can install the full application variant from a terminal by using:
> **Note:** You can install the bare application variant from a terminal by using:
```
composer create-project nova-framework/framework foldername -s dev
composer create-project nova-framework/app foldername 3.* -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](https://github.com/nova-framework/framework/wiki/Install).
> **Note:** For additional installation instructions, for example; setting up a Virtualhost (Recommended for Local Development), Nginx or IIS with URL Rewrite, [please visit the install docs](http://novaframework.com/documentation/v3/install).
## Documentation

Full docs & tutorials are available on [novaframework.com](http://novaframework.com) and the [Github Wiki](https://github.com/nova-framework/framework/wiki).
Full docs & tutorials are available on [novaframework.com](http://novaframework.com/documentation/v3).

Offline docs are available in PDF, EPUB and MOBI formats on [Leanpub](https://leanpub.com/novaframeworkmanual22).

Expand Down
1 change: 1 addition & 0 deletions VERSION.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
4.0.0
1 change: 0 additions & 1 deletion app/.htaccess

This file was deleted.

3 changes: 3 additions & 0 deletions app/Bootstrap.php
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
<?php

//--------------------------------------------------------------------------
// Boot Stage Customization
//--------------------------------------------------------------------------
11 changes: 10 additions & 1 deletion app/Config.php
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
<?php

/**
* Setup the Storage Path.
* Config - the Global Configuration loaded BEFORE the Nova Application starts.
*/


/**
* Define the path to Storage.
*
* NOTE: in a multi-tenant design, every application should have its unique Storage.
*/
define('STORAGE_PATH', BASEPATH .'storage' .DS);

/**
* Define the global prefix.
*
* PREFER to be used in Database calls or storing Session data, default is 'nova_'
*/
define('PREFIX', 'nova_');
Loading

0 comments on commit 43e5d0b

Please sign in to comment.