Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.08 KB

Installation.textile

File metadata and controls

69 lines (45 loc) · 2.08 KB

Installation

Overview

Chicago Boss generally won’t be installed to your system (/usr/local etc.). All of the work occurs in user-land. You’ll download a release, and then use it to generate projects.

Chicago Boss Requirements

Install Erlang R13A or later

Download a Chicago Boss Release

Download the latest code or a release from the website

Compile It

Build Chicago Boss with

make

Generate API docs

To generate the latest documentation of API calls localy:

cd /path/to/ChicagoBoss-x.y.z
make edoc
cd doc/

You should see api.html, api-controller.html, etc

Generate A Project

To create a project in the parent directory, simply type


make app PROJECT=my_new_project

(Project names must start with a lowercase letter.) Then cruise over to it and start up the server:


cd ../my_new_project
./init-dev.sh

(On Windows, execute start-dev.bat instead of start-dev.sh.)

There will be a lot of PROGRESS REPORTs which look scary but hopefully everything is running smoothly. With this console you can interact directly with the running server.

Enjoy

Point your browser to http://localhost:8001/

If all is well you will see a forbidding error message about the requested template — not to worry, the new project is empty so there is nothing to serve!

Next steps:

  • Install the [[Admin Interface]]
  • [[Application Architecture]]
  • [[Example Application]]
  • [[Configuration]]
  • [[An Evening With Chicago Boss]]
  • Chicago Boss API docs