@@ -2,3 +2,23 @@ Flak ==== A private, API-based chat server. + +Setup +----- + + git clone git://github.com/sevenwire/flak.git + # or download and extract from from http://github.com/sevenwire/flak/archives/master + cd flak # or wherever the application was cloned or extracted to, the root of the project + rake flak:setup + # Change config/config.yml and config/database.yml to taste + rake db:create:all + rake db:migrate + script/server + +Use +--- + +* Go to http://localhost:3000 in a browser for an API reference +* Test with lib/flak\_wrapper.rb, which mostly works (requires httparty, which you can install using: gem install httparty) +* Try it out with curl +* Write your own interface README.markdown @@ -3,7 +3,6 @@ class ApplicationController < ActionController::Base include AuthenticatedSystem helper :all - protect_from_forgery - filter_parameter_logging :password + filter_parameter_logging :password, :password_confirmation end app/controllers/application_controller.rb @@ -1,19 +1,33 @@ +# Use sqlite development: - adapter: mysql - encoding: utf8 - reconnect: false - database: flak_development + adapter: sqlite3 + database: db/development.sqlite3 pool: 5 - username: root - password: - socket: /tmp/mysql.sock + timeout: 5000 test: - adapter: mysql - encoding: utf8 - reconnect: false - database: flak_test + adapter: sqlite3 + database: db/test.sqlite3 pool: 5 - username: root - password: - socket: /tmp/mysql.sock + timeout: 5000 + +# Use mysql +# development: +# adapter: mysql +# encoding: utf8 +# reconnect: false +# database: flak_development +# pool: 5 +# username: root +# password: +# socket: /tmp/mysql.sock +# +# test: +# adapter: mysql +# encoding: utf8 +# reconnect: false +# database: flak_test +# pool: 5 +# username: root +# password: +# socket: /tmp/mysql.sock config/database.yml.example @@ -3,5 +3,6 @@ namespace :flak do task :setup do `cp #{Rails.root}/config/config.yml.example #{Rails.root}/config/config.yml` `ruby -pi -e 'gsub(/\\{\\{session_secret\\}\\}/, "#{ActiveSupport::SecureRandom.base64(64)}")' -e 'gsub(/\\{\\{site_key\\}\\}/, "#{ActiveSupport::SecureRandom.hex(24)}")' #{Rails.root}/config/config.yml` + `cp #{Rails.root}/config/database.yml.example #{Rails.root}/config/database.yml` end end lib/tasks/setup.rake 44c342ad52489bb7f8c65399558b0769903cc221 bf91cdf520a98a16551ba487eb0263b75bbca8a3 Nathan Sutton nate@sevenwire.com http://github.com/sevenwire/flak/commit/371dea3e028addca1b040c6c0d83214aefd5f181 371dea3e028addca1b040c6c0d83214aefd5f181 2009-11-02T17:35:52-08:00 2009-11-02T17:35:52-08:00 Merge branch 'master' into rooms 0d1e67865db43e5bfdc8290841e770684bf8f030 Nathan Sutton nate@sevenwire.com