NOTE: This repository is no longer supported or updated by OpenStax. An updated SFAPI built with Python can be found at https://github.com/openstax/sfapi.
The OpenStax Salesforce API - for easier access to Salesforce Org data.
Use the following checklist to get up and running with SFAPI for local development quickly!
- Install PostgreSQL and Ruby (>3.0). It's recommended to use rbenv to manage your Ruby versions.
- Run the following where you'd like to install SFPI
$> git checkout https://github.com/openstax/sfapi.git
$> gem install bundler
$> bundle install
$> createdb sfapi_dev
$> createdb sfapi_test
$> bundle exec rake db:migrate
- Copy the .env.example file to .env and fill in the secrets needed.
You can run the tests with $> bundle exec rspec
Documentation is in the repo wiki
To deploy SFAPI, you will need to use the BIT Deployment Repo. You can find detailed deployment instructions in this wiki entry