# Bluebird
Bluebird is a lightweight PHP MVC framework.

## Table of contents
* [General info](#general-info)
* [Features](#features)
* [Technologies](#technologies)
* [Setup](#setup)
* [Code example](#code-example)
* [Contributing](#contributing)
* [License](#license)

## General info
Bluebird is a lightweight and simple PHP framework designed following the Model-View-Controller (MVC) architecture. It is meant to make your applications easier to create and maintain.

## Features
* MVC architecture
* ORM library based on the ActiveRecord pattern
* Database access through Medoo : https://medoo.in/
* Templating through Latte : https://latte.nette.org/

## Technologies
* PHP version: 7.3+

## Setup
1. Uncompress the archive file in the web directory.
2. Set write permissions on the "var" directory.
3. Set write permissions on the "log" directory.
4. Edit "config/config.php" and enter your base URL.
5. Enter the database settings.

## Code Example

1. Create a new file in the application/controllers directory and name it "hellocontroller.class.php" :
Put the following code snippet in this controller class :
```
<?php
class HelloController extends ActionController {

    public function doIndex() {
    }
}
```

2. Now, create a new file in the templates directory and name it "hello_index.php".

3. Put the following code snippet in "hello_index.php" :
```
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Hello, World !</title>
</head>
<body>
	<p>Hello, World !</p>
</body>
</html>
```

To see our application in action, open a browser window and navigate to http://localhost?rt=hello/hello/index

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
Bluebird is distributed under the GNU General Public License. See LICENSE for more information.

