Skip to content

Latest commit

 

History

History
executable file
·
108 lines (75 loc) · 4.9 KB

README.md

File metadata and controls

executable file
·
108 lines (75 loc) · 4.9 KB

StupidlySimple Framework for PHP

Follow us on Facebook.

Chat with Discord

PHP version Build Style-CI Scrutinizer-CI Total Downloads composer.lock License Made In

StupidlySimple Framework is a micro framework built for lazy developers.

Suitable for those who used to develop vanilla projects, while following today's set of standard.

The core is very small in size, yet it contains most of the functions required to rapidly start developing a project. The name itself is obvious.

Latest Version

Release 0.4.0 (Release Notes)

Table of Contents

No Title
1 Why StupidlySimple?
2 Technical Features
3 How to Install
4 API Documentation

Why StupidlySimple

  • No nonsense
  • Follow your own style
  • Extremely extensible
  • Small in size
  • Lightning fast (<20 ms)

[back to top]

Technical Features

  • Lazy Routing - Route urls according to file names. Your /home will be redirected to home.php and so on. You can also route on specific uri, and/or forward them to a controller.
  • Simple Templating Process - Copy and paste any templates you downloaded to the root directory, and viola, it's up and ready. You can still manage template them however that suits your likings.
  • Integrated with Composer - Download thousands of packages available straight to your project.
  • Integrated with Eloquent ORM - Manage database records with no hassles.
  • Dependency Injection - Minimize coupling and dependant on a single project. And provides easy access to objects and variables.
  • Out-of-the-Box Error Handler - We integrated the framework with Whoops, error handler in a less painful way.

[back to top]

Installation

StupidlySimple requires PHP at least 5.6 to run (with PHPUnit).

Tutorial for installation is available on our website.

Install via Composer

Notice: You can also follow this page for clearer instructions: stupidlysimple.github.io

If you do not have Composer installed, please follow this link for Windows, or this link for Mac Os X and Linux.

As soon as you have installed the Composer already, type this on the Command Prompt (or Terminal)

$ composer create-project stupidlysimple/php myproject

or if you acquired the zip/tarball, issue this command on the Command Prompt (or Terminal)

$ composer update

Once the vendor file is created and all of the packages has been uploaded, you can now view the homepage and start programming. (Be sure to update the project always).

[back to top]

API Documentation

Documentations are available on the wiki page.

Note: If you wish to see the Core files, please go to stupidlysimple/core

Development

Want to contribute? Great! Please do not hesitate to contribute to the framework development.

Nightly Builds

Introducing nightly builds: we are really committed to project that we decided to release nightly builds.

Nightly builds are released more often than the stable build. Eventually a nightly build will be converted to stable.

Get nightly builds

[back to top]

License

MIT

[back to top]

Todo

This is a work in progress. The README.md will be expanded from time to time.

[back to top]