From a921d3eeb597e852e8eef554634cfe284d35e0bd Mon Sep 17 00:00:00 2001 From: joshua stein Date: Fri, 24 Aug 2012 10:39:05 -0500 Subject: [PATCH] add readme, do some cleanup before open sourcing --- .gitignore | 8 + .rbenv-version | 1 + README.md | 50 ++++++ README.rdoc | 261 ------------------------------ app/helpers/invitations_helper.rb | 2 - app/helpers/settings_helper.rb | 2 - script/start_searchd | 2 +- 7 files changed, 60 insertions(+), 266 deletions(-) create mode 100644 .rbenv-version create mode 100644 README.md delete mode 100644 README.rdoc delete mode 100644 app/helpers/invitations_helper.rb delete mode 100644 app/helpers/settings_helper.rb diff --git a/.gitignore b/.gitignore index cc0dbc0..cdeeb2f 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,11 @@ vendor/bundle public/assets + +# files added in production +lib/tasks/deploy.rake +config/initializers/production.rb +config/database.yml +config/initializers/secret_token.rb +config/*.sphinx.conf +config/unicorn.conf.rb diff --git a/.rbenv-version b/.rbenv-version new file mode 100644 index 0000000..9bbcf15 --- /dev/null +++ b/.rbenv-version @@ -0,0 +1 @@ +1.9.3-p0 diff --git a/README.md b/README.md new file mode 100644 index 0000000..98c1e5f --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +###Lobsters Rails Project + +This is the source code to the site operating at [https://lobste.rs](https://lobste.rs). It is a Rails 3 codebase and uses a SQL (MySQL in production) backend for the database and Sphinx for the search engine. + +####Initial setup + +- Install Ruby 1.9.3. + +- Checkout the lobsters git tree from Github + + $ `git clone git://github.com/jcs/lobsters.git` + $ `cd lobsters` + lobsters$ + +- Run Bundler to install/bundle gems needed by the project: + + lobsters$ `bundle` + +- Create a MySQL (other DBs supported by ActiveRecord may work, only MySQL has been tested) database, username, and password and put them in a `config/database.yml` file: + + development: + adapter: mysql2 + encoding: utf8 + reconnect: false + database: lobsters_dev + socket: /tmp/mysql.sock + username: *username* + password: *password* + + test: + adapter: sqlite3 + database: db/test.sqlite3 + pool: 5 + timeout: 5000 + +- Load the schema into the new database: + + lobsters$ `rake db:schema:load` + +- Create a `config/initializers/secret_token.rb` file: + + Lobsters::Application.config.secret_token = '*some 128-bit hexadecimal secret*' + +- (Optional, only needed for search engine) Install Sphinx. Build Sphinx config and start server: + + lobsters$ `rake thinking_sphinx:rebuild` + +- Run the Rails server in development mode: + + lobsters$ `rails server` diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index 7c36f23..0000000 --- a/README.rdoc +++ /dev/null @@ -1,261 +0,0 @@ -== Welcome to Rails - -Rails is a web-application framework that includes everything needed to create -database-backed web applications according to the Model-View-Control pattern. - -This pattern splits the view (also called the presentation) into "dumb" -templates that are primarily responsible for inserting pre-built data in between -HTML tags. The model contains the "smart" domain objects (such as Account, -Product, Person, Post) that holds all the business logic and knows how to -persist themselves to a database. The controller handles the incoming requests -(such as Save New Account, Update Product, Show Post) by manipulating the model -and directing data to the view. - -In Rails, the model is handled by what's called an object-relational mapping -layer entitled Active Record. This layer allows you to present the data from -database rows as objects and embellish these data objects with business logic -methods. You can read more about Active Record in -link:files/vendor/rails/activerecord/README.html. - -The controller and view are handled by the Action Pack, which handles both -layers by its two parts: Action View and Action Controller. These two layers -are bundled in a single package due to their heavy interdependence. This is -unlike the relationship between the Active Record and Action Pack that is much -more separate. Each of these packages can be used independently outside of -Rails. You can read more about Action Pack in -link:files/vendor/rails/actionpack/README.html. - - -== Getting Started - -1. At the command prompt, create a new Rails application: - rails new myapp (where myapp is the application name) - -2. Change directory to myapp and start the web server: - cd myapp; rails server (run with --help for options) - -3. Go to http://localhost:3000/ and you'll see: - "Welcome aboard: You're riding Ruby on Rails!" - -4. Follow the guidelines to start developing your application. You can find -the following resources handy: - -* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html -* Ruby on Rails Tutorial Book: http://www.railstutorial.org/ - - -== Debugging Rails - -Sometimes your application goes wrong. Fortunately there are a lot of tools that -will help you debug it and get it back on the rails. - -First area to check is the application log files. Have "tail -f" commands -running on the server.log and development.log. Rails will automatically display -debugging and runtime information to these files. Debugging info will also be -shown in the browser on requests from 127.0.0.1. - -You can also log your own messages directly into the log file from your code -using the Ruby logger class from inside your controllers. Example: - - class WeblogController < ActionController::Base - def destroy - @weblog = Weblog.find(params[:id]) - @weblog.destroy - logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!") - end - end - -The result will be a message in your log file along the lines of: - - Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1! - -More information on how to use the logger is at http://www.ruby-doc.org/core/ - -Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are -several books available online as well: - -* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe) -* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) - -These two books will bring you up to speed on the Ruby language and also on -programming in general. - - -== Debugger - -Debugger support is available through the debugger command when you start your -Mongrel or WEBrick server with --debugger. This means that you can break out of -execution at any point in the code, investigate and change the model, and then, -resume execution! You need to install ruby-debug to run the server in debugging -mode. With gems, use sudo gem install ruby-debug. Example: - - class WeblogController < ActionController::Base - def index - @posts = Post.all - debugger - end - end - -So the controller will accept the action, run the first line, then present you -with a IRB prompt in the server window. Here you can do things like: - - >> @posts.inspect - => "[#nil, "body"=>nil, "id"=>"1"}>, - #"Rails", "body"=>"Only ten..", "id"=>"2"}>]" - >> @posts.first.title = "hello from a debugger" - => "hello from a debugger" - -...and even better, you can examine how your runtime objects actually work: - - >> f = @posts.first - => #nil, "body"=>nil, "id"=>"1"}> - >> f. - Display all 152 possibilities? (y or n) - -Finally, when you're ready to resume execution, you can enter "cont". - - -== Console - -The console is a Ruby shell, which allows you to interact with your -application's domain model. Here you'll have all parts of the application -configured, just like it is when the application is running. You can inspect -domain models, change values, and save to the database. Starting the script -without arguments will launch it in the development environment. - -To start the console, run rails console from the application -directory. - -Options: - -* Passing the -s, --sandbox argument will rollback any modifications - made to the database. -* Passing an environment name as an argument will load the corresponding - environment. Example: rails console production. - -To reload your controllers and models after launching the console run -reload! - -More information about irb can be found at: -link:http://www.rubycentral.org/pickaxe/irb.html - - -== dbconsole - -You can go to the command line of your database directly through rails -dbconsole. You would be connected to the database with the credentials -defined in database.yml. Starting the script without arguments will connect you -to the development database. Passing an argument will connect you to a different -database, like rails dbconsole production. Currently works for MySQL, -PostgreSQL and SQLite 3. - -== Description of Contents - -The default directory structure of a generated Ruby on Rails application: - - |-- app - | |-- assets - | |-- images - | |-- javascripts - | `-- stylesheets - | |-- controllers - | |-- helpers - | |-- mailers - | |-- models - | `-- views - | `-- layouts - |-- config - | |-- environments - | |-- initializers - | `-- locales - |-- db - |-- doc - |-- lib - | `-- tasks - |-- log - |-- public - |-- script - |-- test - | |-- fixtures - | |-- functional - | |-- integration - | |-- performance - | `-- unit - |-- tmp - | |-- cache - | |-- pids - | |-- sessions - | `-- sockets - `-- vendor - |-- assets - `-- stylesheets - `-- plugins - -app - Holds all the code that's specific to this particular application. - -app/assets - Contains subdirectories for images, stylesheets, and JavaScript files. - -app/controllers - Holds controllers that should be named like weblogs_controller.rb for - automated URL mapping. All controllers should descend from - ApplicationController which itself descends from ActionController::Base. - -app/models - Holds models that should be named like post.rb. Models descend from - ActiveRecord::Base by default. - -app/views - Holds the template files for the view that should be named like - weblogs/index.html.erb for the WeblogsController#index action. All views use - eRuby syntax by default. - -app/views/layouts - Holds the template files for layouts to be used with views. This models the - common header/footer method of wrapping views. In your views, define a layout - using the layout :default and create a file named default.html.erb. - Inside default.html.erb, call <% yield %> to render the view using this - layout. - -app/helpers - Holds view helpers that should be named like weblogs_helper.rb. These are - generated for you automatically when using generators for controllers. - Helpers can be used to wrap functionality for your views into methods. - -config - Configuration files for the Rails environment, the routing map, the database, - and other dependencies. - -db - Contains the database schema in schema.rb. db/migrate contains all the - sequence of Migrations for your schema. - -doc - This directory is where your application documentation will be stored when - generated using rake doc:app - -lib - Application specific libraries. Basically, any kind of custom code that - doesn't belong under controllers, models, or helpers. This directory is in - the load path. - -public - The directory available for the web server. Also contains the dispatchers and the - default HTML files. This should be set as the DOCUMENT_ROOT of your web - server. - -script - Helper scripts for automation and generation. - -test - Unit and functional tests along with fixtures. When using the rails generate - command, template test files will be generated for you and placed in this - directory. - -vendor - External libraries that the application depends on. Also includes the plugins - subdirectory. If the app has frozen rails, those gems also go here, under - vendor/rails/. This directory is in the load path. diff --git a/app/helpers/invitations_helper.rb b/app/helpers/invitations_helper.rb deleted file mode 100644 index 1483b9e..0000000 --- a/app/helpers/invitations_helper.rb +++ /dev/null @@ -1,2 +0,0 @@ -module InvitationsHelper -end diff --git a/app/helpers/settings_helper.rb b/app/helpers/settings_helper.rb deleted file mode 100644 index ffbedba..0000000 --- a/app/helpers/settings_helper.rb +++ /dev/null @@ -1,2 +0,0 @@ -module SettingsHelper -end diff --git a/script/start_searchd b/script/start_searchd index c6e4151..3df0ad4 100755 --- a/script/start_searchd +++ b/script/start_searchd @@ -1,5 +1,5 @@ #!/bin/sh cd /d/rails/lobsters +# rebuild does a start sudo -u lobsters env RAILS_ENV=production bundle19 exec rake19 thinking_sphinx:rebuild -#sudo -u lobsters env RAILS_ENV=production bundle19 exec rake19 thinking_sphinx:start