Following are instructions for installing PartnerBase on a freshly installed Ubuntu Desktop host. This will probably work identically on Ubuntu Server but that has not been tested yet.
Many of these instructions can probably work as is, or easily be translated to work on a Mac.
There are two kinds of installations; one for a developer and another for a deployment. The only difference between the two is that the former will need git installed and need to git clone the repo, whereas the latter can just download a copy of main.
Obviously, if any of these steps are already done you will probably not need to do them, so just ignore those steps.
The Github project page is at https://github.com/rubyforgood/partner.
You'll need to add some packages to those that are included in the installation by default:
sudo apt install curl git nodejs npm postgresql libpq-dev
If you will be using this machine for development, you will need to git clone the repo:
git clone https://github.com/rubyforgood/partner.git
If you only need to have the files but don't need to use git, you can download the zip file and unzip it:
curl -o partner.zip https://codeload.github.com/rubyforgood/partner/zip/main \
&& unzip partner.zip \
&& rm partner.zip
Go to your partner project directory and do this:
sudo npm -g install yarn
yarn install
Go to https://rvm.io/rvm/install and find and run the commands that install the gpg key and install rvm. At the time of this writing (2019-07-26), they are:
gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
\curl -sSL https://get.rvm.io | bash
Open a new terminal tab or window (this will not work in your current shell!). To test rvm, do:
rvm list
If you see something like ‘rvm not found’, you may need to change your terminal settings so that something like “Run command as a login shell” is selected. In the default Ubuntu terminal, you would go to the Edit menu, then select the profile to edit, then select the “Command” tab, and select “Run command as a login shell”. Then open a new shell to proceed.
Install the required version of Ruby (you may be prompted for your system password so that rvm can install some required packages):
rvm install $(cat .ruby-version)
Bundler will probably already be available, but this command will install it if (and only if) it is not:
gem install -v 1.17.2 bundler --conservative
Then, from your project directory, install the gems required for the project:
bundle
By default, Postgres has no password for the admin user. You'll need to set one. Run psql as the Unix user postgres that was added by the Postgres installation:
sudo -u postgres psql
In psql, the following command would add a password whose value is password:
alter user postgres password 'password';
Don't forget that semicolon!
If the command succeeds, psql will respond with:
ALTER ROLE
You can now exit psql, by pressing <Ctrl-D> or typing \q<Enter>.
This project uses a .env file in the project root directory, and it is recommended to use it to include a) the Postgres credentials, and b) the Diaperbank key and endpoint (needed for running the tests locally).
In the project root directory, create an .env file containing:
PG_USERNAME=postgres
PG_PASSWORD=password
DIAPERBANK_KEY="secretpassword"
DIAPERBANK_ENDPOINT="https://diaper.test/api/v1"
The password value needs to be whatever password you set in psql.
From your project directory, initialize the data base:
bin/rails db:setup
You should now be able to successfully run the application:
rails server
Point a browser to localhost:3000. You should see the Partner home page. For login credentials, consult the "Logging In" section of the README.md file.
If you will be running the tests, you will need to download and install the Google Chrome browser.
If you would like to run the tests to further test the installation, you can do so with:
bundle exec rake