Getting Started

Walrus Framework is using RedBean ORM. RedBean works with :

  • MySQL 5 and higher
  • SQLite 3.6.19 and higher
  • PostgreSQL 8 and higher
  • CUBRID (since 3.2)

Walrus is using RedBean because it's simple to use, lightweight and pretty fast for an ORM. That's why we are using it. Here is the documentation of RedBean.

Before you get started, check that two things :

After you have done these two simple things, here is what Walrus architecture looks like and what directories are meant to :

  • Walrus/ - All the files of Walrus Framework. This is where magic happens and where you should look at when you want to contribute.
  • tmp/ - temporary files.
    • cache/ - the cache of your templating language if you use one.
    • logs/ - log directory of Walrus framework
  • config/
    • compiled/ - All YAML config files are converted to PHP files in this directory.
    • routes/ - Your routes YAML files.
    • skeleton/ - Your skeletons YAML files
    • config.php - This is where all your framework configs go (database, ...).
    • deploy.php - Deploy configuration
    • env.php - All environment variables.
  • app/ - All your app files goes here.
      www/ - This is the front-end of your application, basically the files your browsers will be able to get
      • assets/ - All your images, javascript and styles files.
      • index.php - Entry point of your application.
    • helpers/ - Helpers directory.
    • templates/ - Your templates here.
  • vendor/ - Your vendors goes here, few are already included in order to get Walrus working.
  • tusk - Walrus Command Line Interface (CLI).

Speaking of CLI (a.k.a Tusk), it is probably the time for you to create some models or controllers in order to begin a project. Rendez-vous here to see how to use Tusk.