README.md

⚠️ Help Wanted

Website: Pandemic Volunteers

Knowledge base: https://www.notion.so/Pandemic-Volunteers

We need help in HR, PR, PM, design and development. Please get in touch through: https://helpwithcovid.com/projects/441-pandemic-volunteers or [email protected]

⭐ Give Us a Star!

It helps us by getting exposed to your followers. We need more hands.

🕵️ Looking for Feedback

Please have a look at https://PandemicVolunteers.org

Feedback from doctors, medical workers and more would be really appreciated.

Get in touch via email: [email protected]

👩‍💻 Development

Instructions below are for macOS.

Prerequisites

• Homebrew:

bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

• rvm:

gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
curl -sSL https://get.rvm.io | bash -s stable --ruby

Setup

Fork this project

Fork your own copy of hantuzun/pandemic-volunteers to your account. Run the command below in your repository.

$ git clone https://github.com/your-account/pandemic-volunteers

$ cd pandemic-volunteers

Install Ruby 2.7.1

$ rvm install 2.7.1

$ rvm use --default 2.7.1

$ ruby --version

Your ruby version output should begin with ruby 2.7.1.

Install required dependencies

$ brew install yarn

$ yarn install

$ brew install postgresql

$ gem install bundler:2.1.4

Install

$ bundle install
...

Run

Run PostgreSQL. It is required for you to develop the application on your local machine.

$ brew services start postgresql

Run the project:

$ rails server

On your first time running the project, and whenever the DB schema is updated, you need to update your local DB with the following command:

$ rails db:migrate

Visit http://localhost:3000

Test

bundle exec rspec

Deployment

Environment Variables

• DOMAIN: pandemicvolunteers.org Required for Open Graph Images paths and emails.
• SENDGRID_API_KEY: Required for sending emails.