CONTRIBUTE.md

Contributing

Please submit a Pull Request or create an issue with a patch.

Requirements

• Ruby
• Node.js
• PostgreSQL
• Redis

Windows

I highly recommend using WSL w/ Ubuntu for a full dev env, or at least to run services like Postgres/Redis.

For purely native dev you can install the Ruby Dev Kit which uses MSYS2.

Setup

For example, on Ubuntu 18.04:

git clone https://github.com/brentlintner/ocs-tracker.git
cd ocs-tracker
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get update
sudo apt-get install -y nodejs postgresql postgresql-server-dev-all ruby ruby-dev build-essential redis
sudo service redis-server start
sudo service posgresql start
sudo -u postgres createuser -s [yourusername]
sudo -u postgres psql
\password
\q

Then:

npm i -g yarn
gem install bundler
sed -i -e 's/^ruby.*//g' Gemfile # ignore version constraints
bundle
yarn
touch .env

Add this to .env and fill out appropriately.

BROWSER=chrome
SMTP_DEFAULT_FROM=no-reply@ocs-tracker.app
SMTP_DEFAULT_TO=admin-email@foo.com
LOCAL_DB_USER=yourusername|postgres
LOCAL_DB_PASSWORD=dbuserpassword
REDIS_URL=redis://127.0.0.1:6379

Running Locally

rake db:create
rake db:schema:load
rake sync:products
bundle exec foreman start -f Procfile.dev

Note: Windows native doesn't support Puma workers, so you will need to put rails server webrick as the web: command in Procfile.dev.

Native App Wrappers

Uses react-native.

cd native
yarn install
cd -
./bin/native-run-android

Testing

rspec

Deployment

Currently using these services:

• Heroku
• Heroku Postgres
• Heroku Redis
• Mailgun
• Rollbar