Skip to content

Latest commit

 

History

History
66 lines (53 loc) · 2.06 KB

README.org

File metadata and controls

66 lines (53 loc) · 2.06 KB
Raw

webmachine

Overview

Travis-CI :: https://secure.travis-ci.org/basho/webmachine.png

Webmachine is an application layer that adds HTTP semantic awareness on top of the excellent bit-pushing and HTTP syntax-management provided by mochiweb, and provides a simple and clean way to connect that to your application’s behavior.

More information is available here.

Quick Start

A shell script is provided in the webmachine repository to help users quickly and easily create a new webmachine application.

git clone git://github.com/basho/webmachine.git
cd webmachine
./scripts/new_webmachine.sh mydemo

A destination path can also be passed to the new_webmachine.sh script.

./scripts/new_webmachine.sh mydemo ~/webmachine_applications

Once a new application has been created it can be built and started.

cd mydemo
make
./start.sh

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

To learn more continue reading here.

Contributing

We encourage contributions to webmachine from the community.

  1. Fork the webmachine repository on Github.
  2. Clone your fork or add the remote if you already have a clone of the repository.
git clone [email protected]:yourusername/webmachine.git
# or
git remote add mine [email protected]:yourusername/webmachine.git
  1. Create a topic branch for your change.
git checkout -b some-topic-branch
  1. Make your change and commit. Use a clear and descriptive commit message, spanning multiple lines if detailed explanation is needed.
  2. Push to your fork of the repository and then send a pull-request through Github.
git push mine some-topic-branch
  1. A Basho engineer or community maintainer will review your patch and merge it into the main repository or send you feedback.