Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 124 lines (92 sloc) 5.497 kB
f2d082b @richtera Bump version and convert readme to markdown.
richtera authored
1 Calipso
2 -------
3
4 Calipso is a simple NodeJS content management system, built along
5 similar themes to Drupal and Wordpress, that is designed to be fast,
6 flexible and simple.
7
8 For additional details, including installation instructions, please
9 visit the home page: [http://calip.so/][]
10
11 If you would like to contribute, please take a look at the issues list
12 as this will have the most up to date view of work that needs to be done
13 for the next minor release. Otherwise, please just pm myself (cliftonc),
14 dennis (dennishall) or dale (dtan) and we can suggest some places for
15 you to start.
16
17 [![Build Status](https://travis-ci.org/cliftonc/calipso.png)](https://travis-ci.org/cliftonc/calipso)
18
19 ### Quick Install
20
21 If you want to try it out as quickly as possible, please install
22 MongoDB, ensure that you have the right compilers installed (for OSX,
23 XCode4 will work, for Ubuntu, the build-essential and libssl-dev
24 packages) and then use NPM:
25
9083e21 @richtera Squash code style modifications.
richtera authored
26 ```sh
f2d082b @richtera Bump version and convert readme to markdown.
richtera authored
27 npm install calipso -g
28 calipso site /var/www/MySite
29 cd /var/www/MySite
30 calipso server
9083e21 @richtera Squash code style modifications.
richtera authored
31 ```
f2d082b @richtera Bump version and convert readme to markdown.
richtera authored
32
33 #### Using node v0.5.3 and later
34
35 Since node v0.5.3 has removed <code>require.paths</code>, in order to
36 <code>require(‘lib/calipso’)</code>, you must include the following to
37 your file:
38
9083e21 @richtera Squash code style modifications.
richtera authored
39 ```javascript
40 var rootpath = process.cwd() + '/',
41 path = require('path'),
42 calipso = require(path.join(rootpath, 'lib/calipso'));
43 ```
f2d082b @richtera Bump version and convert readme to markdown.
richtera authored
44 That also goes for including anything that is based on the root path of the project directory.
45
46 ### Development Steps
47
48 To get running in development mode (not the site mode outlined on the front page) - e.g. so you can make changes to core and submit pull requests:
49
50 1. Fork the repository
51 2. Clone from your fork (replace YOURNAME!): git clone git@github.com:YOURNAME/calipso.git
52 3. Run 'npm install -d' in the clone folder to install all of the dependencies.
53 4. Run 'node app' to run Calipso from the source folder.
54
55 Note that the bin/calipso command line script is really designed to allow people who just want to use Calipso to build sites to use it, it isn't used in the dev process. As always, any questions please do shout.
56
57 ### Calipso Command Line Client
58
59 The commands currently supported from the command line client are:
60
61 #### Commands That Run Anywhere
62
9083e21 @richtera Squash code style modifications.
richtera authored
63 ```sh
f2d082b @richtera Bump version and convert readme to markdown.
richtera authored
64 calipso : Show this help file.
65 calipso site <name|folder> : Create site in folder.
9083e21 @richtera Squash code style modifications.
richtera authored
66 ```
f2d082b @richtera Bump version and convert readme to markdown.
richtera authored
67
68 #### Commands That Run In Site Folder
69
70 The most important of these at the moment is ‘modules check’ (this will
71 ensure that all modules have all of their dependencies installed via
72 npm), and should be run on site install.
73
9083e21 @richtera Squash code style modifications.
richtera authored
74 ```sh
f2d082b @richtera Bump version and convert readme to markdown.
richtera authored
75 calipso install : Re-run site install.
76
77 calipso cluster --port=3000 : Run as cluster.
78 calipso server --port=3000 : Run as a single server.
79
80 calipso modules list : List installed modules.
81 calipso modules check : Check installation of all modules.
82 calipso modules install *mod@ver : Install module@version, or reinstall module.
83 calipso modules download github : Download module from github (e.g. cliftonc/calipso-elastic)
84 calipso modules enable *mod : Enable module.
85 calipso modules disable *mod : Disable module.
86
87 calipso themes list : List installed themes.
88 calipso themes uninstall *theme : Remove theme (delete from disk)
89 calipso themes download *url : Download (url: http://, gh: cliftonc/calipso-site-theme, repo: calipso-site).
9083e21 @richtera Squash code style modifications.
richtera authored
90 ```
f2d082b @richtera Bump version and convert readme to markdown.
richtera authored
91
92 ### Contributors
93
94 \* [Clifton Cunningham][]
95 \* [Andreas Richter][]
96 \* [Dennis Hall][]
97 \* [Cole Gillespie][]
98 \* [Jonathan Zacsh][]
99 \* [Jerad Bitner][]
100 \* [Martin Moen][]
101 \* [dale tan][]
102 \* [Nate Hunzaker][]
103
104 [http://calip.so/]: http://calip.so/?utm_source=github&utm_medium=calipso&utm_campaign=github
105 [http://travis-ci.org/cliftonc/calipso]: http://travis-ci.org/cliftonc/calipso
106 [Clifton Cunningham]: https://github.com/cliftonc
107 [Dennis Hall]: https://github.com/dennishall
108 [Cole Gillespie]: https://github.com/coleGillespie
109 [Jonathan Zacsh]: https://github.com/jzacsh
110 [Jerad Bitner]: https://github.com/sirkitree
111 [Martin Moen]: https://github.com/botto
112 [dale tan]: https://github.com/dtan
113 [Nate Hunzaker]: https://github.com/nhunzaker
9083e21 @richtera Squash code style modifications.
richtera authored
114 [Andreas Richter]: https://github.com/richtera
115
116 #MIT License
117
118 Copyright (c)
119
120 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
121
122 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
123
124 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWAR
Something went wrong with that request. Please try again.