# Reeder

Experimental app to read RSS subscriptions

## Requirements

- Ruby 2.0
- PostgreSQL
- Redis

## Install

Clone repository and install dependencies:

```
git clone git@github.com:sosedoff/reeder.git
cd reeder
bundle install
```

Create development database:

```
createdb -U postgres reeder_development
```

Migrate database:

```
rake db:migrate
```

## Usage

To start server locally (http://localhost:5000/) type:

```
foreman start
```

This will start web server, feed worker and periodic update worker.

## Testing

Prepare database:

```
createdb -U postgres reeder_test
rake db:migrate RACK_ENV=test
```

To execute test suite:

```
bundle exec rake test
```
# Reeder

Experimental app to read RSS subscriptions

## Requirements

- Ruby 2.0
- PostgreSQL
- Redis

## Install

Clone repository and install dependencies:

```
git clone git@github.com:sosedoff/reeder.git
cd reeder
bundle install
```

Create development database:

```
createdb -U postgres reeder_development
```

Migrate database:

```
rake db:migrate
```

## Usage

To start server locally (http://localhost:5000/) type:

```
foreman start
```

This will start web server, feed worker and periodic update worker.

## API Documentation

Check `API.md` file for API documentation and reference.

## Testing

Prepare database:

```
createdb -U postgres reeder_test
rake db:migrate RACK_ENV=test
```

To execute test suite:

```
bundle exec rake test
```
Add API reference to readme
Add API reference to readme
