Development Environment

Run rake setup to prepare the necessary environment variables to begin development. After that, you will need to run rvm use . to load the environment variables generated in .ruby-env.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/on-site/Grantzilla. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

This project is available as open source under the terms of the MIT License.

Linux Setup

# For Ubuntu 16+, change 9.3. to 9.5 whereever it appears in the line below:
sudo apt-get install -y postgresql-9.3 postgresql-server-9.3 postgresql-client-common libmagickwand-dev imagemagick
# Change my_user_name and my_secret_password before running the next 2 commands
sudo su - postgres -c "psql -c 'CREATE USER my_user_name WITH PASSWORD '\''my_secret_password'\'''"
sudo su - postgres -c "psql -c 'ALTER USER my_user_name CREATEDB'"
git clone https://github.com/on-site/Grantzilla.git
which rvm >> /dev/null || \curl -sSL https://get.rvm.io | bash -s stable
rvm install `cat Grantzilla/.ruby-version`
cd Grantzilla
gem install bundler
bundle
rake setup # When prompted, use the same username and password as in the CREATE USER command above
cd .

OSX Setup

1. Install Postgres at postgresapp.com

2. Install node.js, if you don't already have it

3. Install HomeBrew, if you don't have it already

4. Install dependencies

   brew update
   brew install imagemagick
   git clone https://github.com/on-site/grantzilla.git
   

5. Install RVM, if you don't have it already

   \curl -sSL https://get.rvm.io | bash -s stable
   rvm install `cat .ruby-version`
   cd .
   

6. Install gems

   gem install bundler
   bundle
   

7. Run app setup

   rake setup
   rvm use .
   spring stop