Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 72 lines (44 sloc) 3.708 kb
af46a37 @chrislloyd README is now formatted by textile (useful in GitHub).
chrislloyd authored
1 h1. Enki
0036481 @xaviershay WIP README
authored
2
9a3eaa7 @joneslee85 Add Travis Status Badge [ci skip]
joneslee85 authored
3 !https://travis-ci.org/xaviershay/enki.png?branch=master!:https://travis-ci.org/xaviershay/enki
4
c0c6450 @zachinglis Capitalizing Ruby on Rails
zachinglis authored
5 A Ruby on Rails blogging app for the fashionable developer.
0036481 @xaviershay WIP README
authored
6
8982c5e @xaviershay Sync up the readme with enkiblog.com home page
authored
7 Preferences are for the masses. Any real coder knows the easiest and best way to customize something is by *hacking code*. Because you want your blog to be you, not bog standard install #4958 with 20 posts per page instead of 15. For this you need a *clean, simple, easy to understand code base* that stays out of your way. No liquid drops and templates hindering your path, no ugly PHP(Hypertext Preprocessor) stylings burning your eyeballs.
0036481 @xaviershay WIP README
authored
8
af46a37 @chrislloyd README is now formatted by textile (useful in GitHub).
chrislloyd authored
9 h2. Quick Start
0036481 @xaviershay WIP README
authored
10
b28b7f9 @xaviershay gah whitespace
authored
11 <pre><code> git clone git://github.com/xaviershay/enki.git enki
13e39c6 @xaviershay Updated README
authored
12 cd enki
13 git checkout -b myblog # Create a new work branch
d478219 @xaviershay Fix install instructions
authored
14 bundle install # Install all the required gems
15
8f5c63a @xaviershay Update README and FEATURES
authored
16 cp config/database.example.yml config/database.yml
24feb61 @xaviershay Added rake db:migrate to quick start instructions
authored
17 # Edit config/enki.yml and config/database.yml to taste
26ac458 @xaviershay Adjustments to install notes (thanks sheldon hearn)
authored
18
19 # Next step needs libxml2 and libxslt1 and their headers
20 # On Debian-based systems: apt-get install libxml2-dev libxslt1-dev
21 # On Mac OS X: no action required
22
2d0d06c @xaviershay Remove default secret token.
authored
23 rake secret # Paste output into place in config/initializers/secret_token.rb
24feb61 @xaviershay Added rake db:migrate to quick start instructions
authored
24 rake db:migrate
d478219 @xaviershay Fix install instructions
authored
25 rake # Run tests
26 rails server # Start the server
b28b7f9 @xaviershay gah whitespace
authored
27 # Load http://localhost:3000/admin in your browser</code></pre>
0036481 @xaviershay WIP README
authored
28
8982c5e @xaviershay Sync up the readme with enkiblog.com home page
authored
29 Or for bonus points, fork "enki at github":http://github.com/xaviershay/enki/tree/master and clone that instead.
30
af46a37 @chrislloyd README is now formatted by textile (useful in GitHub).
chrislloyd authored
31 h2. More info
0036481 @xaviershay WIP README
authored
32
b24c097 @xaviershay Updated README and FEATURES
authored
33 Enki is a compact, easily extendable base for your blog. It does this by being highly opinionated, for example:
0036481 @xaviershay WIP README
authored
34
af46a37 @chrislloyd README is now formatted by textile (useful in GitHub).
chrislloyd authored
35 * Public facing views should adhere to standards (XHTML(eXtensible Hypertext Markup Language), Atom)
36 * /yyyy/mm/dd/post-title is a good URL for your posts
37 * Live comment preview should be provided by default
38 * Google does search better than you or I
39 * You don't need a plugin system when you've got decent source control
40 * If you're not using OpenID you're a chump
41 * Hacking code is the easiest way to customize something
48a07eb @xaviershay Updated README
authored
42
06bdeaf Tweak URL path prefix patch to address feedback from xaviershay
Marcel M. Cary authored
43 h2. URL path prefix
44
45 Enki can run your blog with a URL path prefix. For example, you can run it at example.com/*blog* instead of blog.example.com. You can do so with the RAILS_RELATIVE_URL_ROOT environment variable, set either before starting the server or in config/application.rb before Enki::Application. Uncommenting this line in config/application.rb will enable this behavior in all environments:
46
47 <pre><code>ENV['RAILS_RELATIVE_URL_ROOT'] = '/blog'</code></pre>
48
8982c5e @xaviershay Sync up the readme with enkiblog.com home page
authored
49 h2. How it differs from Mephisto
50
51 Mephisto is feature packed and quite customizable. It can however be daunting trying to find your way around the code, which isn’t so good if you’re trying to hack in your own features. Enki strips out a lot of the features that you probably don’t need (multiple authors and liquid templates, for example), and focuses on keeping a tight code base that is easy to comprehend and extend.
52
53 h2. How it differs from SimpleLog
54
55 Enki embodies much of the philosophy of SimpleLog, but does so in a style that is much more consistent with Rails best practices, making it easier to understand and hack the code.
56
4208613 @xaviershay Add compatibility to README
authored
57 h2. Compatibility
58
c235118 @joneslee85 Bump to Rails 4.
joneslee85 authored
59 Uses Ruby 1.9.3 or newer and Rails 4. Runs on MySQL or Postgres. Works on heroku.
4208613 @xaviershay Add compatibility to README
authored
60
af46a37 @chrislloyd README is now formatted by textile (useful in GitHub).
chrislloyd authored
61 h2. Contributors, these guys rock
532c025 @xaviershay Update README (add contributors and update to github) and FEATURES
authored
62
b28b7f9 @xaviershay gah whitespace
authored
63 <pre><code>git log | grep Author | sort | uniq</code></pre>
532c025 @xaviershay Update README (add contributors and update to github) and FEATURES
authored
64
dbe3b05 @xaviershay Add more contributor notes to the README.
authored
65 If you want to help out, try tackling an "open issue":https://github.com/xaviershay/enki/issues. Please include specs for any fixes. Enki is by design feature light. Unless you feel very strongly your feature should be in core, add a link to your fork in the wiki instead.
dcf03e3 @xaviershay Add link to open issues
authored
66
af46a37 @chrislloyd README is now formatted by textile (useful in GitHub).
chrislloyd authored
67 h2. License
f78aaac @xaviershay LICENSE
authored
68
af46a37 @chrislloyd README is now formatted by textile (useful in GitHub).
chrislloyd authored
69 GPL(General Public License) - See LICENSE
f78aaac @xaviershay LICENSE
authored
70
09b015c @xaviershay Remove obsolete simplelog stuff
authored
71 Admin design heavily inspired by "Habari":http://www.habariproject.org/en/
Something went wrong with that request. Please try again.