Skip to content

matiboux/Oli

Repository files navigation

Oli BETA 1.8.1

Oli is an open source PHP framework made to help you creating your website.
The framework brings up various development tools such as database and user management, and more. ♪

Want to know more about the project team? Check out the "Team" section!

Get started!

Warning: The BETA is barely documented.

Prerequisites

First, you need to make sure you have a working web server set up, with PHP installed.

As the framework is currently in BETA, please be careful with your installation: Oli is developed using an Apache server with PHP 7.0 and MySQL installed, and no tests has been run using other configations.

Install

Download the latest release, extract the archive and place Oli in your web server file directory.
The last thing you'll have to do is the config! Need help with that? Here's a more detailed guide to get started. (WIP)

Once the framework set up, you can create and place your pages in the /content/theme/... directory as .php files.
You can place your CSS stylesheets and JS scripts in the /content/theme/assets/... directory for an easier access through Oli, using its built-in HTML tools.

Some extras

You might also want to look into other things that might help you:
Want to use a database with your website? Import the default Oli SQL file in your MySQL database, and update your config.json file with the MySQL access infos.
Need to use the account management feature? Learn about the official Oli login page!

Interesting by things made by the community? Check out what projects and addons they made!

You have something to add to the framework? Let us know, or learn about creating your own addon for Oli. (WIP)
Don't forget to share your creations with us! ♪

You

Please make sure to read the Code of Conduct before getting involved in the project, either by participating or by contributing.

Contributing

You have something to add to the framework? You can contribute to the project by developing addons. To do so, learn about creating your own addon for Oli (WIP).

If you want to suggest new features, feel free to open a new issue or see the "Team" section to contact us.

You can also get involved in the framework developement, if you'd like to. Please read the Contributing file first! (WIP)

Help & Support

Have trouble? Need some help with something?
You can check out the "Team" section to contact us directly or open a new issue.


License

Copyright (C) 2015-2017 Matiboux (Mathieu Guérin)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program.
If not, see http://www.gnu.org/licenses/.

You'll find a copy of the GNU AGPL v3 license in the LICENSE file.

This license applies to the...

  • /index.php file
  • /load.php file
  • /form.php file
  • files in /includes/... – and in its sub-directories

This license does not applies to the...

  • /config.json and /mysql.json config files
  • /.gitignore file
  • /oli.default.sql file (which is licensed under the MIT license)
  • New API files that might be created in the / directory
  • .htaccess files

These directories may contains content that might be licensed under another license:

  • files in /content/... – and in its sub-directories
  • files in /addons/... – and in its sub-directories

Paths beginning with / are relative to the main directory of this repository.


Team

Creator & Developer: Matiboux (Mathieu Guérin)
Want to get in touch with me? Here's how:

Contributors

See who also contributed to this project!

Thanks credits

@SeeMyPing, who suggested "Oli" as the framework name.

@Elionatrox, who helped me for a while..


Community and feedbacks are everything! Help is always appreciated! <3