A fork of Coronasafe Journal project.
Track movement of Oxygen cylinders. (Workflow)
Build with Rails and React ❤️
Ruby 2.7
We recommend a managing tool like rbenv to install Ruby. After installing `rbenv`, you can run `rbenv install` from this repository root to install compatible ruby version.Foreman
Foreman is a task runner used in the Ruby ecosystem. After installing Ruby you can install it with `gem install foreman`PostgreSQL
We use PostgreSQL for the database. Checkoutconfig/database.yml.postgresqlfor default keys in use. If you are on Mac, you can install Postgres with `brew install postgres`
NodeJS
We recommend using a version manager such as NVM. After install NVM, you can use any Node version higher than 12 to run the application.nvm install 12
./bin/setup
foreman start -f Procfile.dev
API endpoints have test coverage.
bundle exec rake test
will run the test suite.
Build image
- Clone the repo.
- Setup
config/master.key
. docker-compose build
.
Run
- Setup env variables. (list in
config/docker-compose.yml
) docker-compose run web rake db:migrate
.docker-compose up
.- React app will be compiled at
public/packs
.
Video: https://share.getcloudapp.com/Blu50Kl4
https://github.com/coronasafe/journal/blob/develop/doc/api.md
- Run
rake db:seed
. - Setup environment variables
ADMIN_LOGIN
&&ADMIN_PASSWORD
. - Schedule
CleanupOldDataJob.perform_now
to be run once every day, probably midnight. - Setup the OTP service AppKey as an environment variable
SMS_API_KEY
- Setup environment variable
RAILS_SERVE_STATIC_FILES
=true
Checkout the issues page. When you find one to your skill liking and skill level, please leave us a comment that you are taking it up.
If you are new to open source, checkout Open Source Guide
You can contact us through issues or find us on Slack.
This project is MIT licensed.