README

Using Octo for a new site

You can find a working example site in the Octo Skeleton project.

To get started:

• Clone: git clone git@github.com:Block8/Octo-Skeleton.git <your site name>
• Move into your new project directory: cd <your site name>
• If you want to try out the example site:
  • Create a database and import into it the content from octo-skeleton.sql
  • Modify siteconfig.php to point to that database
• If you want to create a new site:
  • Remove the .git folder and create as a new repo: rm -Rf .git && git init
  • Modify the siteconfig.php file as necessary for your project
  • Rename the Example namespace and modify the code within it for your project

Dependencies

Block 8

Third Party

Octo would not be possible without the help of the following open source projects:

Back-end

• b8 framework by Block 8 (@block8)
• Twig by Fabien Potencier (@fabpot)
• Symfony Console by Symfony (@symfony)
• Phinx by Rob Morgan (@robmorgan)
• PHP 5.5 Password Compat by Anthony Ferrara (@ircmaxell)
• Pheanstalk by Paul Annesley (@pda)
• Google API Client by Google (@google)
• Twitter PHP library by David Grudl (@dg)

Front-end

• Bootstrap CSS by Mark Otto (@mdo) & Jacob (@fat)
• Admin LTE by Abdullah Almsaeed (@almasaeed2010)
• Select2 by Kevin Brown (@kevin-brown) and Igor Vaynberg (@ivaynberg)
• CKEditor by CKSource (@ckeditor)