wrap at 80
This commit is contained in:
parent
d5cf5bc4f5
commit
95bad5f46b
30
README.md
30
README.md
|
@ -1,22 +1,27 @@
|
||||||
###Lobsters Rails Project
|
###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.
|
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
|
####Initial setup
|
||||||
|
|
||||||
- Install Ruby 1.9.3.
|
* Install Ruby 1.9.3.
|
||||||
|
|
||||||
- Checkout the lobsters git tree from Github
|
* Checkout the lobsters git tree from Github
|
||||||
|
|
||||||
$ git clone git://github.com/jcs/lobsters.git
|
$ git clone git://github.com/jcs/lobsters.git
|
||||||
$ cd lobsters
|
$ cd lobsters
|
||||||
lobsters$
|
lobsters$
|
||||||
|
|
||||||
- Run Bundler to install/bundle gems needed by the project:
|
* Run Bundler to install/bundle gems needed by the project:
|
||||||
|
|
||||||
lobsters$ bundle
|
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:
|
* 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:
|
development:
|
||||||
adapter: mysql2
|
adapter: mysql2
|
||||||
|
@ -33,19 +38,19 @@ This is the source code to the site operating at [https://lobste.rs](https://lob
|
||||||
pool: 5
|
pool: 5
|
||||||
timeout: 5000
|
timeout: 5000
|
||||||
|
|
||||||
- Load the schema into the new database:
|
* Load the schema into the new database:
|
||||||
|
|
||||||
lobsters$ rake db:schema:load
|
lobsters$ rake db:schema:load
|
||||||
|
|
||||||
- Create a `config/initializers/secret_token.rb` file:
|
* Create a `config/initializers/secret_token.rb` file:
|
||||||
|
|
||||||
Lobsters::Application.config.secret_token = 'some 128-bit hexadecimal secret here'
|
Lobsters::Application.config.secret_token = 'some 128-bit hexadecimal secret here'
|
||||||
|
|
||||||
- (Optional, only needed for search engine) Install Sphinx. Build Sphinx config and start server:
|
* (Optional, only needed for search engine) Install Sphinx. Build Sphinx config and start server:
|
||||||
|
|
||||||
lobsters$ rake thinking_sphinx:rebuild
|
lobsters$ rake thinking_sphinx:rebuild
|
||||||
|
|
||||||
- Create an initial administrator user and at least one tag:
|
* Create an initial administrator user and at least one tag:
|
||||||
|
|
||||||
lobsters$ rails console
|
lobsters$ rails console
|
||||||
Loading development environment (Rails 3.2.6)
|
Loading development environment (Rails 3.2.6)
|
||||||
|
@ -58,8 +63,11 @@ This is the source code to the site operating at [https://lobste.rs](https://lob
|
||||||
irb(main):005:0> t.tag = "test"
|
irb(main):005:0> t.tag = "test"
|
||||||
irb(main):006:0> t.save
|
irb(main):006:0> t.save
|
||||||
|
|
||||||
- The default development hostname is defined as `lobsters.localhost:3000`. You should define this in `/etc/hosts` (or through DNS) to point to `127.0.0.1`.
|
* The default development hostname is defined as `lobsters.localhost:3000`.
|
||||||
|
You should define this in `/etc/hosts` (or through DNS) to point to
|
||||||
|
`127.0.0.1`.
|
||||||
|
|
||||||
- Run the Rails server in development mode. You should be able to login to `http://lobsters.localhost:3000` with your `test` user:
|
* Run the Rails server in development mode. You should be able to login to
|
||||||
|
`http://lobsters.localhost:3000` with your `test` user:
|
||||||
|
|
||||||
lobsters$ rails server
|
lobsters$ rails server
|
||||||
|
|
Loading…
Reference in a new issue