Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.33 KB

README.md

File metadata and controls

57 lines (40 loc) · 1.33 KB

Mirotic

Mirotic is an MVC framework for Hack + HHVM

Latest Version: 0.0 -- In Development

Overview

Project Structure:

  • config/
    • Mirotic.php -- Stores app-wide configuration information. Customize at will.
    • config.ini -- Additional configuration settings for HHVM
  • bin/
    • mir -- Framework util app. Used for code generation, etc.
  • src/
    • controllers/ -- The logic for a particular route
    • elements/ -- Place for all XHP elements
    • exceptions/ -- Place for all exceptions
    • generated/ -- Place for any (auto)generated code
    • lib/ -- Place for Mirotic framework code
    • pages/ -- The HTML for a particular route
    • utils/ -- Various utility classes/functions
  • public/
    • css -- Where all the CSS lives
    • img -- Where all the images live
    • index.php -- Entrypoint to the application
    • js -- Where all the JS lives

Installation

Mirotic uses composer for dependency management. To install, please run:

hhvm $(which composer) install

Running

To run the server locally for debugging,

hhvm -m server -c config/config.ini -p 8080

The site will be available at http://localhost:8080.

Mir

Mir is the name of the framework toolkit. It's a CLI program that will handle the mundane things like creating new routers, linting, etc.

To run,

hhvm bin/mir