Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 71 lines (54 sloc) 2.57 kB
8778e94 @soveran Initial commit
soveran authored
1 Monk
2 ====
3
4 The glue framework for web development.
5
6 Description
7 -----------
8
9 Monk is a glue framework for web development. It means that instead of
10 installing all the tools you need for your projects, you can rely on a
49f5518 @soveran Removed glue from lib/monk
soveran authored
11 git repository and a list of dependencies, and Monk takes care of the
8778e94 @soveran Initial commit
soveran authored
12 rest. By default, it ships with a Sinatra application that includes
13 Contest, Stories, Webrat, Ohm and some other niceties, along with a
14 structure and helpful documentation to get your hands wet in no time.
15
16 But Monk also respects your tastes, and you are invited to create your
17 own versions of the skeleton app and your own list of dependencies. You
18 can add many different templates (different git repositories) and Monk
19 will help you manage them all.
20
21 Usage
22 -----
23
24 Install the monk gem and create your project:
25
26 $ sudo gem install monk
27 $ monk init myapp
28 $ cd myapp
29 $ rake
30
49f5518 @soveran Removed glue from lib/monk
soveran authored
31 If the tests pass, it means that you can start hacking right away. If
8778e94 @soveran Initial commit
soveran authored
32 they don't, just follow the instructions. As the default skeleton
33 is very opinionated, you will probably need to install and run
34 [Redis](http://code.google.com/p/redis/), a key-value database.
35
36 Check the `dependencies` file in the root of your project to see what
37 else is there. Monk works with git almost exclusively, but your project
38 can also depend on gems. Check the dependencies file to see what options
39 you have, and run the `dep` command line tool to verify it.
40
41 Installation
42 ------------
43
44 $ sudo gem install monk
45
46 License
47 -------
48
49 Copyright (c) 2009 Michel Martens and Damian Janowski
50
51 Permission is hereby granted, free of charge, to any person
52 obtaining a copy of this software and associated documentation
53 files (the "Software"), to deal in the Software without
54 restriction, including without limitation the rights to use,
55 copy, modify, merge, publish, distribute, sublicense, and/or sell
56 copies of the Software, and to permit persons to whom the
57 Software is furnished to do so, subject to the following
58 conditions:
59
60 The above copyright notice and this permission notice shall be
61 included in all copies or substantial portions of the Software.
62
63 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
64 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
65 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
66 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
67 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
68 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
69 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
70 OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.