mishina2228/oanda-api-rails

# oanda-api-rails

[![CI](https://github.com/mishina2228/oanda-api-rails/workflows/ci/badge.svg)](https://github.com/mishina2228/oanda-api-rails/actions)
[![Maintainability](https://api.codeclimate.com/v1/badges/b6b9044754816afc195c/maintainability)](https://codeclimate.com/github/mishina2228/oanda-api-rails/maintainability)
[![codecov](https://codecov.io/gh/mishina2228/oanda-api-rails/branch/master/graph/badge.svg)](https://codecov.io/gh/mishina2228/oanda-api-rails)
[![GitHub license](https://img.shields.io/github/license/mishina2228/oanda-api-rails)](https://github.com/mishina2228/oanda-api-rails/blob/master/LICENSE)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)

Get exchange data using OANDA API

## Prerequisites

- Ruby 3.1+
- Node.js 14.17.0+ || 16.0.0+
- Yarn 1.x+

## Installation

### Set up Rails app

First, install the gems and javascript packages required by the application:

```sh
bundle
yarn
```

Next, execute the database migrations/schema setup:

```sh
bin/rails db:setup
```

### Resque settings

Create a configuration file to manage [Resque](https://github.com/resque/resque)
and [resque-scheduler](https://github.com/resque/resque-scheduler)
with [God](http://godrb.com/)

```sh
RAILS_ENV=[RAILS_ENV] bundle exec itamae local config/itamae/resque.rb
```

Load configuration file

```sh
god -c /etc/god/master.conf
```

Resque, resque-scheduler operation with God

- check the status
- start
- restart
- stop

```sh
god status resque-oanda_api_rails
god start resque-oanda_api_rails
god restart resque-oanda_api_rails
god stop resque-oanda_api_rails
```

### Start the app

#### development

```sh
bin/dev
```

#### production

```sh
bin/rails assets:precompile RAILS_ENV=production
bin/rails s -e production
```

## Configuration Files

### Notify when Resque job failed

If a Resque job fails, a notification email will be sent.  
Please fill in the settings of email to config/mail.yml .  
The following is an example when sending from Gmail:

```yml
production:
  delivery_method: :smtp
  smtp_settings:
    address: 'smtp.gmail.com'
    port: 587
    domain: 'gmail.com'
    user_name: [USER_NAME]
    password: [PASSWORD]
    authentication: 'plain'
    enable_starttls_auto: true
  recipients:
    - [EMAIL_ADDRESS]
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request