1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
* webmachine
** Overview
[[http://travis-ci.org/basho/webmachine][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 [[http://webmachine.basho.com/][here]].
** Quick Start
A shell script is provided in the =webmachine= repository to help
users quickly and easily create a new =webmachine= application.
#+BEGIN_SRC shell
git clone git://github.com/basho/webmachine.git
cd webmachine
./scripts/new_webmachine.sh mydemo
#+END_SRC
A destination path can also be passed to the =new_webmachine.sh=
script.
#+BEGIN_SRC shell
./scripts/new_webmachine.sh mydemo ~/webmachine_applications
#+END_SRC
Once a new application has been created it can be built and started.
#+BEGIN_SRC shell
cd mydemo
make
./start.sh
#+END_SRC
The application will be available at [[http://localhost:8000]].
To learn more continue reading [[http://webmachine.basho.com/][here]].
** Contributing
We encourage contributions to =webmachine= from the community.
1) Fork the =webmachine= repository on [[https://github.com/basho/webmachine][Github]].
2) Clone your fork or add the remote if you already have a clone of
the repository.
#+BEGIN_SRC shell
git clone git@github.com:yourusername/webmachine.git
# or
git remote add mine git@github.com:yourusername/webmachine.git
#+END_SRC
3) Create a topic branch for your change.
#+BEGIN_SRC shell
git checkout -b some-topic-branch
#+END_SRC
4) Make your change and commit. Use a clear and descriptive commit
message, spanning multiple lines if detailed explanation is
needed.
5) Push to your fork of the repository and then send a pull-request
through Github.
#+BEGIN_SRC shell
git push mine some-topic-branch
#+END_SRC
6) A Basho engineer or community maintainer will review your patch
and merge it into the main repository or send you feedback.
|
