add deprecation notice
[leap_website.git] / README.md
1 About this web application
2 ============================
3
4 This repository is DEPRECATED, move on to https://0xacab.org/leap/leap_se !
5
6 The LEAP public website is lightweight rails application that just mostly
7 serves up (semi) static templates.
8
9 No databases are used or harmed in the making of this website.
10
11 The goal with this web app is to be as flexible and lightweight as possible,
12 and to support stellar localization.
13
14 There are numerous ruby tools to build static websites, but I found them to
15 not be good for localization and to be too inflexible.
16
17 Installation
18
19     sudo apt-get install ruby ruby-dev rubygems
20     gem install bundler
21     git clone git://leap.se/leap_website
22     cd leap_website
23     bundle
24
25 Optional
26
27     sudo apt-get install python-docutils    # for ReStructuredText support
28
29 Running in development mode
30
31     cd leap_website
32     rails server thin
33
34 Console examples
35
36     rails console
37     rails console production
38     rails dbconsole
39
40 Rake takes
41
42     rake doc:app
43
44 Running in production (with thin)
45
46     bundle exec rake assets:precompile
47     RAILS_ENV=production rails server thin
48
49
50 Modifying pages
51 ======================================
52
53 Edit the HAML files found in leap_website/pages
54
55
56 Deploying
57 ======================================
58
59 Manually
60 ----------------
61
62     rsync -a leap_website server:~
63     ssh server
64     cd leap_website
65     bundle install --deployment
66
67 With Capistrano
68 ---------------------
69
70     Edit config/deploy.rb
71     cap setup
72     cap deploy
73
74 Running with Apache
75 ------------------------
76
77 Install Passenger (mod_rack)
78
79    sudo apt-get install libapache2-mod-passenger
80
81 Configure Apache
82
83     <VirtualHost *:80>
84       ServerName leap.se
85       DocumentRoot /home/leap/leap_website/public
86       <Directory /home/leap/leap_website/public>
87         Allow from all
88         Options -MultiViews
89       </Directory>
90     </VirtualHost>
91
92
93 Development
94 ==============================
95
96 This app uses precompiled assets.
97
98 If you change a sass source file, you must run this before deploying:
99
100   rake assets:precompile RAILS_ENV=production
101
102 To make the stylesheets autogenerate again in development mode, run this:
103
104   rake assets:clean
105
106
107 Development Notes
108 =============================
109
110 Search
111 ---------------------------
112
113 Maybe we should add search.
114
115 This appears to be the most appropriate search tool to use for this static webapp: http://xapian.org/docs/bindings/ruby/
116
117 Some notes on how flask does a similar thing::
118 * http://librelist.com/browser//flask/2012/3/21/maillinglist-archive-searchable/#ff1d34246a16845c410d2c9a411f5829
119 * https://github.com/mitsuhiko/flask/blob/website/flask_website/search.py
120 * https://github.com/mitsuhiko/flask/blob/website/flask_website/views/mailinglist.py
121
122 pure ruby, for ar: https://github.com/dougal/acts_as_indexed/
123
124 Other static CMS in ruby
125 -----------------------------
126
127 * http://nestacms.com/
128 * https://github.com/gma/nesta
129 * https://github.com/gma/nesta-rails
130 * https://github.com/quickleft/regulate -- git, engine, cms, rails
131
132