cleanup doc markup [ci skip]
This commit is contained in:
wvengen
parent
24b0628825
commit
63e2ec9d49
8 changed files with 649 additions and 708 deletions
|
|
@ -14,44 +14,41 @@ Getting started
|
|||
---------------
|
||||
|
||||
0. Clone the repository from GitHub:
|
||||
```
|
||||
git clone https://github.com/foodcoops/foodsoft.git
|
||||
```
|
||||
|
||||
git clone https://github.com/foodcoops/foodsoft.git
|
||||
|
||||
This brings up the bleeding-edge development version, which might contain some
|
||||
unfinished parts. If you want to be safe, choose the last release:
|
||||
`git checkout $(git tag -l | grep ^v | sort -rn | head -n1)`
|
||||
|
||||
1. Install RVM and Ruby 2.0 (if you have not done so before):
|
||||
```
|
||||
\curl -L https://get.rvm.io | bash
|
||||
source ~/.rvm/scripts/rvm
|
||||
rvm install 2.0
|
||||
```
|
||||
|
||||
\curl -L https://get.rvm.io | bash
|
||||
source ~/.rvm/scripts/rvm
|
||||
rvm install 2.0
|
||||
|
||||
We try to keep foodsoft compatible with Ruby 1.9.3 as well as any later versions,
|
||||
so if you have those and don't want to use RVM, that might actually work.
|
||||
|
||||
2. Install Ruby dependencies:
|
||||
```
|
||||
bundle install
|
||||
```
|
||||
|
||||
bundle install
|
||||
|
||||
3. Setup your development environment:
|
||||
```
|
||||
rake foodsoft:setup_development
|
||||
```
|
||||
|
||||
rake foodsoft:setup_development
|
||||
|
||||
This will interactively prompt with several questions relating to your
|
||||
required environment.
|
||||
|
||||
4. Start rails by running:
|
||||
```
|
||||
bundle exec rails s
|
||||
```
|
||||
|
||||
bundle exec rails s
|
||||
|
||||
5. Open your favorite browser and open the web application at:
|
||||
```
|
||||
http://localhost:3000/
|
||||
```
|
||||
|
||||
http://localhost:3000/
|
||||
|
||||
You might want to watch a
|
||||
[kitten video](https://www.youtube.com/watch?v=9Iq5yCoHp4o)
|
||||
while it's loading.
|
||||
|
|
@ -75,21 +72,20 @@ explained here.
|
|||
1. **Configure database**
|
||||
|
||||
Create the database configuration from the default:
|
||||
```sh
|
||||
cp config/database.yml.SQLite_SAMPLE config/database.yml
|
||||
```
|
||||
|
||||
cp config/database.yml.SQLite_SAMPLE config/database.yml
|
||||
|
||||
If you are fine with using a file-based sqlite database you are all set.
|
||||
The sqlite files (development/test/production) will reside in the "db"
|
||||
The sqlite files (`development/test/production`) will reside in the `db`
|
||||
directory. Otherwise you would want to copy one of the other
|
||||
"database.yml.*_SAMPLE" files and edit database.yml to suit your needs.
|
||||
`database.yml.*_SAMPLE` files and edit `database.yml` to suit your needs.
|
||||
|
||||
|
||||
2. **Configure development environment**
|
||||
|
||||
Again, you need to create your own copy of the default configuration:
|
||||
```
|
||||
cp config/environments/development.rb.SAMPLE config/environments/development.rb
|
||||
```
|
||||
|
||||
cp config/environments/development.rb.SAMPLE config/environments/development.rb
|
||||
|
||||
Edit development.rb to specify your settings (at least the ActionMailer SMTP
|
||||
settings). If you just leave the file as is, emails will not work but
|
||||
|
|
@ -99,10 +95,10 @@ explained here.
|
|||
3. **Foodsoft settings**
|
||||
|
||||
You need to create your own copy of the foodsoft configuration settings:
|
||||
```
|
||||
cp config/app_config.yml.SAMPLE config/app_config.yml
|
||||
```
|
||||
Edit app_config.yml to suit your needs or just keep the defaults for now.
|
||||
|
||||
cp config/app_config.yml.SAMPLE config/app_config.yml
|
||||
|
||||
Edit `app_config.yml` to suit your needs or just keep the defaults for now.
|
||||
|
||||
|
||||
4. **Secret token**
|
||||
|
|
@ -110,16 +106,16 @@ explained here.
|
|||
The user session are stored in cookies. Do avoid misusing the cookies and
|
||||
its sensitive information, rails will encrypt it with a token. So copy the
|
||||
config file
|
||||
```
|
||||
cp config/initializers/secret_token.rb.SAMPLE config/initializers/secret_token.rb
|
||||
```
|
||||
|
||||
cp config/initializers/secret_token.rb.SAMPLE config/initializers/secret_token.rb
|
||||
|
||||
and modify the token!! You can run `bundle exec rake secret`
|
||||
|
||||
|
||||
5. **Create database (schema) and load defaults**
|
||||
```
|
||||
rake db:setup
|
||||
```
|
||||
|
||||
rake db:setup
|
||||
|
||||
With this, you also get a ready to go user with username 'admin' and
|
||||
password 'secret'.
|
||||
|
||||
|
|
@ -129,13 +125,12 @@ explained here.
|
|||
We use for time intensive tasks a background job queue, at the moment resque
|
||||
with redis as key/value store. Install redis (in ubuntu the package
|
||||
redis-server works out of the box) and start the resque worker with:
|
||||
```
|
||||
rake resque:work QUEUE=foodsoft_notifier
|
||||
```
|
||||
|
||||
rake resque:work QUEUE=foodsoft_notifier
|
||||
|
||||
To have look on the current queue, failed jobs etc start the resque server with
|
||||
```
|
||||
resque-web
|
||||
```
|
||||
|
||||
resque-web
|
||||
|
||||
|
||||
7. (optional) **View mails in browser** instead in your logs
|
||||
|
|
@ -143,10 +138,10 @@ explained here.
|
|||
We use mailcatcher in development mode to view all delivered mails in a
|
||||
browser interface. Just install mailcatcher with gem install mailcatcher
|
||||
and start the service with
|
||||
```
|
||||
mailcatcher
|
||||
```
|
||||
|
||||
mailcatcher
|
||||
|
||||
From now on you have a smtp server listening on 1025. To see the emails go to
|
||||
```
|
||||
http://localhost:1080
|
||||
```
|
||||
|
||||
http://localhost:1080
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue