This documentation will introduce you to your new favorite Node.js web framework.

We want to make you immediately productive with CoffeeShop. Know this is a living document, and we welcome any contributions toward constant improvement.
Let’s get started!

1. Getting Started

1.1. Install Node.js (using NVM is recommended)

      sudo apt-get remove nodejs npm # if it was installed before this
curl https://raw.github.com/creationix/nvm/master/install.sh | sh
nvm install 0.8.16 # we test on latest stable
nvm use 0.8.16
nvm alias default 0.8.16

1.2. Install CoffeeShop and Dependencies

      # install CoffeeSprites/node-gd dependencies
sudo apt-get install libgd2-xpm-dev build-essential # libgd, build tools
sudo apt-get install pngcrush # optional optimizer makes PNG files smaller
# install CoffeeShop dependencies
npm install coffee-script -g # gives `cake` binary
# install CoffeeShop
npm install coffee-shop -g

1.3. Generate New Skeleton

      shop new Bakery
cd Bakery/

1.4. Start the Server

      shop open

1.5. Open Browser (using Google Chrome recommended)

1.6. Explore Help

      shop help

2. Contributing Back

Everyone is encouraged to help improve CoffeeShop. You will find our maintainers to be extremely friendly and responsive.

2.1 Issuing a Pull Request

  1. fork and clone https://github.com/mikesmullin/coffee-shop

  2. edit to heart’s content

  3. publish to your fork:

              git commit && git push
  4. issue pull request to official fork, and we will review and approve or provide feedback.

3. Further Reading

  • CoffeeTemplates
  • CoffeeStylesheets