This application leverages ORCID services and ORCID iDs for researchers in the Princeton community.
- Ruby: 3.2.0
- nodejs: 18.17.0
- yarn: 1.22.19
- Lando: 3.6.2
Update the file config/banner.yml
. Note that each environment can have its own banner text.
- A Mailinator account is required for you to be able to verify your ORCID account. "Setup" your Mailinator your email:
- visit https://www.mailinator.com/v4/public/inboxes.jsp
- put a fake email address (e.g., myname) into the search box at the top of the page.
- your email wil include
@mailinator.com
(e.g.myname@mailinator.com
) even though you do not need to put@mailinator.com
in the search box
- your email wil include
- Click go and you will be taken to the "inbox" for that email.
- Use the mailinator email address (e.g.
myname@mailinator.com
) to register an account at https://sandbox.orcid.org/register - Record your login and password in a password manager so you can find them again.
- Now in mailinator respond to the verification email.
- If you do not see your email make sure the search box has your email. You do not need to include
mailinator.com
- Click the verify button in the email
- If you do not see your email make sure the search box has your email. You do not need to include
- Your account should now be verified in the OCRID Sandbox
- Check out code and
cd
- Install tool dependencies; If you've worked on other PUL projects they will already be installed.
- Install asdf dependencies with asdf
asdf plugin add ruby
asdf plugin add node
asdf plugin add yarn
asdf install
- ... but because asdf is not a dependency manager, if there are errors, you may need to install other dependencies. For example:
brew install gpg
- Or, if you are using
ruby-install
andchruby
(instead ofasdf
):ruby-install 3.2.0 -- --with-openssl-dir=$(brew --prefix openssl@1.1)
- close the terminal window and open a new terminal
chruby 3.2.0
ruby --version
- Install language-specific dependencies
bundle install
yarn install
We use lando to run services required for both test and development environments.
Start and initialize database services with:
bundle exec rake servers:start
To stop database services:
bundle exec rake servers:stop
or lando stop
- Fast:
bundle exec rspec spec
- Run in browser:
RUN_IN_BROWSER=true bundle exec rspec spec
bundle exec rails server
bundle exec ./bin/vite dev
(within another terminal)- Access application at http://localhost:3000/
gem install foreman
bundle exec foreman start
(this runs the Rails server and Vite simultaneously)- Access application at http://localhost:3000/
You need to have the following variables in your environment to connect with the ORCID sandbox. Actual values are in lastpass under "ORCID Local API key". export ORCID_CLIENT_ID="xxx" export ORCID_CLIENT_SECRET="xxx"
RDSS uses the same release and deployment process for all projects.
In compliance with ORCID's general brand guidance around capitalization of the ORCID organization name and ORCID identifier information, we use the following written style to refer to ORCID and ORCID identifiers:
- ORCID - (noun) the ORCID organization; (adjective) part of a noun phrase that refers to things that are about ORCID, but not by the organization itself
- Noun example: "ORCID is a global, not-for-profit organization."
- Adjective example: "Click here to view your ORCID record"
- ORCID identifer or ORCID iD (abbreviation) - unique identifer offered by the ORCID organization