What Is SprintPHP?
Sprint is a set of additional tools on top of CodeIgniter 3 that provide common solutions
and elegant workflows to the problems that you encounter on most every application you create for your company
or your clients. Over 100 hours have been put into this codebase, creating simple tools for you to use to drastically reduce the
amount of time it takes you to create new applications.
- Very secure Authorization system.
- Flat-RBAC (Role Based Access Control) system
- Flexible theme system based on CI's standard views
- with callable "widgets"
- and mobile/tablet variant views
- and simple meta-tag management
- Context-based escaping of data
- Flexible cron management
- Simple Events system to hook into system code
- CLI-based code generation
- Email Queue with local "Log" driver and CI-mail driver
- Easily extend to work with Postmark, Mandrill or your favorite.
- More powerful routing system
- System to base your new API off of.
- and more...
While this guide covers the basics to help you find your way around, the complete documentation is viewable
and searchable in every Sprint installation, located at
yoursite.dev/docs, or on GitHub.
Sprint is best installed through Composer on the command line.
$ composer create-project sprintphp/sprintphp <install folder> dev-develop
This will download the code, run some cleanup and setup a couple of things like the application's encryption key,
and get you ready to go.
You can find more information in the Installation Guide.
Finding Your Way Around
Once you've installed it, you will find that Sprint contains a typical CodeIgniter application, as well as a
few additional folders that contain its code. I tried to design Sprint to stay out of your application as much
application - The normal CodeIgniter application folder (with a couple of additional items)
database - This folder holds your migrations
mailers - Contains classes
that construct your emails before sending them out.
modules - contains any modules that you want to create.
build - You can mostly ignore this (and it might not even be there depending on your installation type.)
myth - This folder holds all of Sprint's code.
system - CodeIgniter lives here.
tests - A home for your tests. We ship Codeception with it to help you out.
themes - Holds all of your site and email themes. Comes with some examples as a starting off point.
If you've used CodeIgniter before (if you haven't - read their docs first)
then you can jump right in and start creating your application. Things work just the same, but you have some additional tools at
To help you get started as fast as possible, you should read the following guides first, since they cover the topics that
you will use most often. Then, you can read through the rest of the docs as you need to.
- Controllers - Covers the
different controllers Sprint provides to accelerate your development.
- Themes - Covers hows themes work,
how to set them up, and how to incorporate them into your controller usage.
- Views - Provides additional details
on working with views and the template system
- Models - Covers the extremely powerful
base model that provides many common functions to make working with database tables simple.
- Routes - Take advantage of the additional
routing capabilities to customize your application structure to your needs.