Go to file
Andrey Chernih 9e849de0f7 Add task to generate test data 2014-07-07 12:15:28 +04:00
app for direct-comment links, just use an anchor instead of js to scroll 2014-07-03 11:25:30 -05:00
bin upgrade to rails v4.0.2 2013-12-30 17:40:52 -05:00
config add support for /top and things like /top/3m and /top/2w 2014-04-03 13:20:24 -05:00
db implement story merging 2014-04-08 17:51:12 -05:00
extras Sponge: keep user-supplied headers separate 2014-07-02 09:58:52 -05:00
lib Add task to generate test data 2014-07-07 12:15:28 +04:00
public use one of gravatar's default avatars rather than our own 2014-01-21 00:22:40 -06:00
script don't mail stories and comments to users that have hidden that story 2014-03-24 10:26:07 -05:00
spec Cleanup tags to avoid non-unique value SQL error 2014-07-07 11:48:42 +04:00
vendor/assets upgrade to rails v4.0.2 2013-12-30 17:40:52 -05:00
.gitignore ignore all of log/ so the app user can own it 2014-04-01 09:05:50 -05:00
.rspec initial work on conversion from php tree 2012-06-16 20:15:46 -05:00
.ruby-version rename .rbenv-version file 2014-01-15 05:16:25 +04:00
CONTRIBUTING.md update readme/contributing to explain about non-lobste.rs use 2013-02-24 19:52:09 -06:00
Gemfile Add task to generate test data 2014-07-07 12:15:28 +04:00
Gemfile.lock Add task to generate test data 2014-07-07 12:15:28 +04:00
LICENSE bump copyright to 2014 2014-01-12 13:28:07 -06:00
README.md add note about compatibility with ruby 2.0.0 and 2.1.0 in README 2014-01-13 03:21:50 -05:00
Rakefile upgrade to rails v4.0.2 2013-12-30 17:40:52 -05:00
config.ru upgrade to rails v4.0.2 2013-12-30 17:40:52 -05:00

README.md

###Lobsters Rails Project

This is the source code to the site operating at https://lobste.rs. It is a Rails 4 codebase and uses a SQL (MariaDB in production) backend for the database and Sphinx for the search engine.

While you are free to fork this code and modify it (according to the license) to run your own link aggregation website, this source code repository and bug tracker are only for the site operating at lobste.rs. Please do not use the bug tracker for support related to operating your own site unless you are contributing code that will also benefit lobste.rs.

####Contributing bugfixes and new features

Please see the CONTRIBUTING file.

####Initial setup

  • Install Ruby. Supported Ruby versions include 1.9.3, 2.0.0 and 2.1.0.

  • 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 and MariaDB have been tested) database, username, and password and put them in a config/database.yml file:

        development:
          adapter: mysql2
          encoding: utf8mb4
          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, using a randomly generated key from the output of rake secret:

        Lobsters::Application.config.secret_token = 'your random secret here'
    
  • (Optional, only needed for the search engine) Install Sphinx. Build Sphinx config and start server:

        lobsters$ rake ts:rebuild
    
  • Define your site's name and default domain, which are used in various places, in a config/initializers/production.rb or similar file:

        class << Rails.application
          def domain
            "example.com"
          end
    
          def name
            "Example News"
          end
        end
    
        Rails.application.routes.default_url_options[:host] = Rails.application.domain
    
  • Create an initial administrator user and at least one tag:

        lobsters$ rails console
        Loading development environment (Rails 3.2.6)
        irb(main):001:0> u = User.new(:username => "test", :email => "test@example.com", :password => "test", :password_confirmation => "test")
        irb(main):002:0> u.is_admin = true
        irb(main):003:0> u.is_moderator = true
        irb(main):004:0> u.save
    
        irb(main):005:0> t = Tag.new
        irb(main):006:0> t.tag = "test"
        irb(main):007:0> t.save
    
  • Run the Rails server in development mode. You should be able to login to http://localhost:3000 with your new test user:

        lobsters$ rails server