Developer Setup

Vets API requires:

• PostgreSQL
  • Including PostGIS
• Redis
• Ruby 2.4.5

Base Setup

To start, fetch this code:

git clone https://github.com/department-of-veterans-affairs/vets-api.git

<script id="asciicast-RUjdzdl2QoKAtByJy8aFUNvci" src="https://asciinema.org/a/RUjdzdl2QoKAtByJy8aFUNvci.js" data-speed="3" async></script>

Automated (OSX)

If you are developing on OSX, you can run the automated setup script. From the vets-api directory, run ./bin/setup-osx && source ~/.bash_profile && cd .

Alternative (OSX)

1. Install Ruby 2.4.5
   • It is suggested that you use a Ruby version manager such as rbenv and install Ruby 2.4.5.
   • NOTE: rbenv will also provide additional installation instructions in the console output. Make sure to follow those too.
2. Install Bundler to manage dependencies
   • gem install bundler
   • <script id="asciicast-FvrKFQEn7LPU2uJWEwKs4qWdD" src="https://asciinema.org/a/FvrKFQEn7LPU2uJWEwKs4qWdD.js" data-speed="3" async></script>
3. Install Postgres and enable on startup
   • brew install postgres
   • brew services start postgres
   • <script id="asciicast-qP6m9dJO12VUQNCRlPhSp0Gxv" src="https://asciinema.org/a/qP6m9dJO12VUQNCRlPhSp0Gxv.js" data-speed="20" async></script>
4. Install PostGIS
   • brew install postgis
   • <script id="asciicast-CNXY78BJsmWVCu1h7D3U4Y0dI" src="https://asciinema.org/a/CNXY78BJsmWVCu1h7D3U4Y0dI.js" data-speed="30" async></script>
5. Install Redis
   • brew install redis
   • Follow post-install instructions to enable Redis on startup. Otherwise, launch it manually with brew services start redis.
   • <script id="asciicast-UaSV2iPYXBP1YpFV9MrGPJgfp" src="https://asciinema.org/a/UaSV2iPYXBP1YpFV9MrGPJgfp.js" data-speed="3" async></script>
6. Install ImageMagick
   • brew install imagemagick
   • <script id="asciicast-wt0PV8fC7u9k8dWnyMc8kvPdz" src="https://asciinema.org/a/wt0PV8fC7u9k8dWnyMc8kvPdz.js" data-speed="15" async></script>
7. Install Poppler
   • brew install poppler
   • <script id="asciicast-bglBU8sebtYUSHLFEqN0jGfdS" src="https://asciinema.org/a/bglBU8sebtYUSHLFEqN0jGfdS.js" data-speed="15" async></script>
8. Install ClamAV

• brew install clamav

• Take note of the the post-install instructions "To finish installation & run clamav you will need to edit the example conf files at ${conf_files_dir}", which will vary depending on your homebrew installation

  • cd ${conf_files_dir}
  • touch clamd.sock
  • echo "LocalSocket ${conf_files_dir}" > clamd.conf
  • echo "DatabaseMirror database.clamav.net" > freshclam.conf
  • freshclam -v
  • <script id="asciicast-bfO1404XqTKNz6RPSUkUmrY5A" src="https://asciinema.org/a/bfO1404XqTKNz6RPSUkUmrY5A.js" data-speed="15" async></script>

9. Install pdftk
10. Install gem dependencies: cd vets-api; bundle install

• <script id="asciicast-MO9y7K9l05hfIHJydPIJ471kg" src="https://asciinema.org/a/MO9y7K9l05hfIHJydPIJ471kg.js" data-speed="3" async></script>
• More information about installing with Sidekiq Enterprise as well as our credentials are on the internal system here: https://github.com/department-of-veterans-affairs/vets-api#authentication-required-for-enterprisecontribsyscom

11. Install overcommit overcommit --install --sign

• <script id="asciicast-VzNNnYm4OkBvWYy3EJvm6bDVs" src="https://asciinema.org/a/VzNNnYm4OkBvWYy3EJvm6bDVs.js" data-speed="3" async></script>

12. Setup localhost certificates / keys:

• Create certs directory within config: mkdir ./config/certs

• Copy the certificate to ./config/certs/vetsgov-localhost.crt

• Copy the key to ./config/certs/vetsgov-localhost.key

• NOTE: If you don't have access to these keys, running the following commands will provide basic functionality, such as for running unit tests:

• touch ./config/certs/vetsgov-localhost.crt

• touch ./config/certs/vetsgov-localhost.key

• NOTE: using touch to create blank cert and key files means that local authentication with IDme will not work

• <script id="asciicast-dReuUt7pIMEjMhZ88QIud0SG4" src="https://asciinema.org/a/dReuUt7pIMEjMhZ88QIud0SG4.js" data-speed="3" async></script>

13. Create dev database: bundle exec rake db:setup 14. Go to the file config/settings/development.yml in your local vets-api. Switch the commented out lines pertaining to the cache_dir: uncomment out line 14 (what you use for running the app via Rails), and comment out line 15 (what you use for running the app via Docker). 15. Make sure you have the vets-api-mockdata repo locally installed, preferably in a parallel directory to vets-api. 16. Make sure you have the vets-api-mockdata repo locally installed 17. Create a config/settings.local.yml file for your local configuration overrides. Add this key pointing to your vets-api-mockdata directory.

betamocks:
  cache_dir: ../vets-api-mockdata

Alternative (Ubuntu 18.04 LTS)

1. Install Postgres, PostGIS, Redis, ImageMagick, Poppler, ClamAV, etc
   • From the vets-api directory, run ./bin/install-ubuntu-packages
2. Edit /etc/ImageMagick-6/policy.xml and remove the lines below the comment <!-- disable ghostscript format types -->
   • This may not be necessary. The default policy was updated to fix a variety of vulnerabilities as of October, 2018.
3. Install Ruby 2.4.5
   • It is suggested that you use a Ruby version manager such as rbenv and install Ruby 2.4.5.
   • NOTE: rbenv will also provide additional installation instructions in the console output. Make sure to follow those too.
4. Install Bundler to manage dependencies
   • gem install bundler
5. Install gem dependencies: cd vets-api; bundle install
6. Install overcommit overcommit --install --sign
7. Setup localhost certificates / keys:
   • Create certs directory within config: mkdir ./config/certs
   • Copy these certificates into the certs dir.
     • NOTE: If you don't have access to these keys, running the following commands will provide basic functionality, such as for running unit tests:
     • touch ./config/certs/vetsgov-localhost.crt
     • touch ./config/certs/vetsgov-localhost.key
8. Create dev database: bundle exec rake db:setup
9. Make sure you have the vets-api-mockdata repo locally installed, preferably in a parallel directory to vets-api.
10. Create a config/settings.local.yml file for your local configuration overrides. Add this key pointing to your vets-api-mockdata directory.

betamocks:
  cache_dir: ../vets-api-mockdata