Skip to content

Latest commit

 

History

History
171 lines (112 loc) · 6.09 KB

README.md

File metadata and controls

171 lines (112 loc) · 6.09 KB
Raw

README

This is the draft version of the Data Point of Care (DPC) website. The website has a sign-up section allowing providers to volunteer for beta-testing the DPC application. The sign-up section, and whatever functionality and specialized content that we provide signed up beta participants will require authentication to view. In addition, there is an administrator portal to manage the registration and communications with the participants.

All of the static public pages are now hosted on a separate static site. This may result in broken links when run locally.

Installation of Ruby

This is a Ruby on Rails driven website, so you'll need Ruby and a few "gems" to get up and running. Installing Ruby and Rails, as well as PostGresql - the database on a Windows environment is difficult, and beyond the scope of this document - sorry, but you'll need a third party package to install Ruby, such as Ruby Installer. Disclaimer: the previous sentence was not an endorsement.

The situation for OSX is much, much simpler using Homebrew. You can install ruby directly from Ruby's site (https://www.ruby-lang.org/en/). Using homebrew, you can also install ruby directly.

Optional Installation of Homebrew to install Ruby or Rbenv

We can use homebrew to install ruby directly, or to install both a ruby version manager (rbenv) and a gemset manager(rbenv gemset). To install homebrew, either navigate to the homebrew link and follow the directions, or in the terminal window issue the following

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Once homebrew is installed, you can either install the latest version of ruby directly (brew install ruby) or you can optionally install rbenv in the terminal window:

brew install rbenv

Follow the message brew install issues once rbenv is installed. This is important - you'll need to edit the ~/.bash_profile.

You can now install the latest version of Ruby on your machine, or the version this app uses: 2.6.2 as follows:

rbenv install 2.6.2
rbenv rehash

Following the installation of rbenv, install rbenv-gemset. This is an optional step, but its good not to overcomplicate your gemsets.

brew install rbenv-gemset

Installing Postgresql

Lastly, install postgresql, if necessary, using homebrew:

brew install postgresql

Follow the prompts following the installation to start running postgres as a service.

Installation and Configuration of the Application

Assuming you have access to the github repository housing this application (since you are reading this), clone the project using SSH or HTTPS. Change into the directory where you want the website to reside and using the command line. For SSH:

git clone git@github.com:CMSgov/dpc-app.git

For HTTPS:

https://github.com/CMSgov/dpc-app.git

You'll need to

  1. Change into the installation directory dpc-app/dpc-web
  2. If you are using rbenv-gemset issue the following
rbenv gemset create {latest-ruby-version: eg 2.6.2} dpc-website
  1. gem install bundler --no-document
  2. Run bundle install
  3. Run npm install

Credentials

The database is password encrypted. Credentials are passed via environment variables. See the "Running the Server" section for information on which environment variables to set.

Running the server

rails db:create db:migrate db:seed
rails server

Add a .env file

Create a .env file in the root directory. This is where you will put your environment variables.

Note: If you need to change the database configuration, it can be overridden using the DB_USER, DB_PASS, and DATABASE_URL environment variables. Example:

DB_USER=postgres
DB_PASS=password
DATABASE_URL=postgresql://localhost/dpc-website_development

You also need to set the Github ENV variables to enable Github OAuth login for internal users:

GITHUB_APP_ID=xxx
GITHUB_APP_SECRET=yyy
GITHUB_ORG_TEAM_ID=123

If you want to switch to the sandbox environment, add the ENV variable:

ENV=prod-sbx

Static Pages

All static public pages are hosted in a separate jekyll site. To run the full suite, clone and follow the local instructions for the jekyll site to run at the same time as this web app.

You will need to add a STATIC_SITE_URL variable to your .env file:

STATIC_SITE_URL=http://localhost:4001

Background job processing

In order to process background jobs such as sending email, you need to make sure Sidekiq is running:

Open a new terminal window and execute the following in the root /dpc-web folder.

bundle exec sidekiq

This command starts Sidekiq in the current terminal. To stop Sidekiq: ctrl-c, and it will shutdown the worker.

Running via Docker

The DPC website can also be run via docker. Follow the below steps to build and run the website into a Docker container.

Build the Docker Container

To build the container, simply run the following command:

docker compose build

Start the Docker Container

The following command will start both the database server and rails server:

docker compose up

Stop / Destroy the Docker Container

When you're done, shut down the server with the following command (this also destroys the database):

docker compose down

Note: The web app defaults to http://localhost:3500/.

Run Web App and Admin App simultaneously

After starting the web app, follow instructions to set up the admin app in dpc-app/dpc-admin in another terminal window. Follow set up directions for that application and in the second terminal window run: rails s or rails server.

Testing

To test the rails app, run rspec spec in the terminal.

To test the JWT generator, run npm test in the terminal.

Production

When running in production, the Docker Compose database should not be used. RDS should be used instead. Additionally, the following environment variable should be used to set production mode: RAILS_ENV=production.