Skip to content

Latest commit

 

History

History
87 lines (47 loc) · 3.88 KB

README.md

File metadata and controls

87 lines (47 loc) · 3.88 KB
Raw

Erdiko

Package version CircleCI Scrutinizer Code Quality License

About Erdiko

Erdiko is a micro MVC framework, or better yet, a lean framework for APIs, web apps and websites. Erdiko is developer and start up friendly.

Take a lean approach to your next PHP project.

Learning Erdiko

See our full documentation at http://erdiko.org/

Installation

We recommend installing Erdiko with [composer](here https://getcomposer.org/). At the commandline simply run:

	composer create erdiko/erdiko [your-app-name]

Erdiko is easy to use with Nginx or Apache. Simply set the webroot to public/default/

Docker

You don't need Docker to run Erdiko, but we are big fans and want to make it easy to use with Docker if you desire.

If you want to run your new site using Docker use our bundled container scripts by running docker-compose in the root of your project.

	docker-compose up -d

You will need to add erdiko.local to your etc hosts file.

127.0.0.1       erdiko.local

Your dev site will now be running at http://erdiko.local/

Alternative Installation

(Via git & docker)

This option will give you a fully working container environment and install all of the required packages. It assumes you have both docker and docker-compose installed.

git clone git@github.com:Erdiko/erdiko.git
cd erdiko
docker-compose up &
docker exec -it erdiko_php /bin/bash
cd /code
composer install

See the Docker section for more information.

Vision

Erdiko wants to make your php development easier. If you need a lightweight MVC framework then this is the tool for you. Our goal is to offer a clean platform to create sites optimized for web applications, websites, & APIs.

Erdiko can also act as a mash-up framework too, hence the name 'erdiko' which means 'central' or 'middle' in the Basque language (Euskara). Use Erdiko if you need to mash-up multiple packages, applications or even full frameworks. Combine things like Symfony Components, Laravel Packages, Drupal, Magento, WordPress, and Zend into a unified application.

Security

Security is very important to us. If you discover any vulnerabilities within Erdiko or any of our packages, please create a github issue and send an e-mail to John Arroyo at john@arroyolabs.com. Security is top concern and all vulnerabilities will be quickly addressed.

Notes

We value feedback and would love to hear your thoughts about the architecture and ease of use of this framework. There are a lot of possibilities for Erdiko, we value your ideas and thoughts about where to take this codebase.

Upgrades

If you are upgrading from version 0.9.0 or earier than you need to adjust the configs in app/config folder. The structure has changed slightly. Move app/config/application/default.json to app/config/default/application.json and app/config/application/routes.json to app/config/default/routes.json. Take a look at the latest configs in this repo and make sure they adhere to the new structure.

Credits

  • John Arroyo
  • Andy Armstrong
  • Leo Daidone

All Contributors

  • If you want to help, please do, we'd love more brainpower! Fork, commit your enhancements and do a pull request. If you want to get to even more involved please contact us!

Sponsors

Arroyo Labs

License

Erdiko is open-sourced software licensed under the MIT license