Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 4.3 KB

README.md

File metadata and controls

111 lines (76 loc) · 4.3 KB
Raw

Rails Devs

The reverse job board for Rails developers.

railsdevs homepage

railsdevs empowers independent developers available for their next gig. It is being built around three core values:

  1. Empowering the independent developer
  2. Doing everything in public
  3. Creating a safe, inclusive environment

Getting started

Requirements

You will need a few non-Ruby packages installed. Install these at once via:

brew bundle install --no-upgrade

...or manually:

  • Ruby 3.1.0
  • libpq - brew install libpq
    • libpg is needed to use the native pg gem without Rosetta on M1 macs
  • postgresql - brew install postgresql
  • node - brew install node
  • Yarn - brew install yarn
  • Redis - brew install redis
  • Imagemagick - brew install imagemagick
  • Stripe CLI - brew install stripe/stripe-cli/stripe
  • foreman - gem install foreman
  • Google Chrome + Chromedriver for system tests - brew install --cask google-chrome chromedriver

Initial setup

Start PostgreSQL server.

brew services start postgresql

Start Redis server.

brew services start redis

An installation script is included with the repository that will automatically get the application setup.

bin/setup

Development

Run the following to start the server and automatically build assets.

  • Requires foreman or overmind
  • Requires stripe
bin/dev

Seeds

Seeding the database, either via rails db:seed or during bin/setup, creates a few accounts. Most importantly, use [email protected] and [email protected] with password password.

More information is in the docs on seeds.

Stripe

You will need to configure Stripe or do a mock configuration (ie set dummy values for the last step listed below) if you are working on anything related to payments.

  1. Register for Stripe and add an account
  2. Download the Stripe CLI via brew install stripe/stripe-cli/stripe
  3. Login to the Stripe CLI via stripe login
  4. Configure your development credentials
    1. Create a Stripe secret key for test mode
    2. Run stripe listen --forward-to localhost:3000/pay/webhooks/stripe in order to generate your webhook signing secret.
    3. Create a product with a recurring, monthly price
    4. Generate your editable development credentials file via EDITOR="mate --wait" bin/rails credentials:edit --environment development. You may need to install and provide terminal access to the editor first (mate, subl, and atom should all work). If you run the code above and receive the message "New credentials encrypted and saved", without having had the opportunity to edit the file first, things have gone astray. You will need to troubleshoot this step based on your OS and desired editor, to ensure you are able to edit the development.yml file before it is encoded and saved. See here for more details.
    5. Add the secret key, the price, and your webhook signing secret to your development credentials in the following format, and save/close the file:
stripe:
  private_key: sk_test_YOUR_TEST_STRIPE_KEY
  signing_secret: whsec_YOUR_SIGNING_SECRET
  price_ids:
    part_time_plan: price_YOUR_PRODUCT_PRICE_ID
    full_time_plan: price_ANOTHER_PRODUCT_PRICE_ID

Monitoring

Application monitoring is powered by Scout APM. This helps identify N+1 queries, slow queries, memory bloats, and more. Scout APM is free for open source.

Testing

  • Run rails test to run unit/integration tests.
  • Run rails test:system to run system tests, using headless_chrome.
  • Run HEADFUL=1 rails test:system to run system tests, using headful_chrome.

Changelog

Significant changes and product updates are documented in the changelog.