Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (77 loc) · 3.84 KB

CONTRIBUTING.md

File metadata and controls

104 lines (77 loc) · 3.84 KB
Raw

Setting up a development environment

Heidi, it's time to cook! 🧑‍🍳

You'll need Docker Compose, Ruby, and Rails to run Flavortown. We strongly encourage using a Unix-based system (Linux or macOS). If you're on Windows, check out GitHub Codespaces!

  1. Clone this repo!

    git clone https://github.com/hackclub/flavortown

    (this will already be done for you if you use GitHub Codespaces!)

  2. Set up a PostgreSQL database.

    docker compose up -d db

  3. Enter Rails via Docker Compose. Run all other commands within this container!

    docker compose run --service-ports web /bin/bash

  4. Install all dependencies.

    bundle install

  5. Set up your .env file by copying over example.env. You'll need to follow the instructions in said .env file!

    cp example.env .env

  6. Create an app on Hack Club Auth (HCA) Staging. Go to https://hca.dinosaurbbq.org/developer/apps, and click the app me up! button.

    • redirect URI: http://localhost:3000/oauth/callback
    • select ALL THE SCOPES!!!!

    You may get an error like The requested scope is invalid, unknown, or malformed when authenticating. If this is the case:

    • copy the &state=<...> parameter of the failing URL.
    • go to your app on HCA, and Right click > Copy Link on Test Auth to the right of the redirect URI.
    • you should get a URL like this: 
      https://hca.dinosaurbbq.org/oauth/authorize?client_id=c1b86a9f2073eec8e457ce3eb169afb9&redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Foauth%2Fcallback&response_type=code&scope=openid+profile+email+name+slack_id+verification_status
    • append the &state=<...> parameter you copied in the first step to the URL
    • navigate to that URL, and go through the normal auth flow

    This is only an issue in development environments.

  7. Generate Rails credentials.

    EDITOR="nano" bin/rails credentials:edit --environment=development
    ⚠️ You might not be able to run credentials:edit from outside the Docker container because of build errors. If this is the case, click here.

    credentials:edit might fail on your machine outside of the Docker container. For example, on a fresh GitHub Codespaces box, I couldn't install the faiss gem, as it failed the build step.

    The problem with this is that we have no visual editors in the Docker container. As such, you'll have to install one.

    # For Debian/Ubuntu:
apt-get update && apt-get install -y nano

# For Alpine:
apk update && apk add nano

# For CentOS:
yum install nano

    After installing nano, you should be able to invoke credentials:edit.


    You'll see an editor with a .yml file open. Take a look at docs/example_dev_creds.yml for examples of how this file should look like! You've already generated some of these for .env - make sure they're the same.

    If you're using nano, press CTRL + S to save, then CTRL + X to exit.

  8. It's time to cook! Run bin/dev!

Starting the development environment back up again

If you already did all of the steps above previously, but e.g. your PC or Codespace restarted, you only need to do a subset of the steps above.

  1. Set up a PostgreSQL database.

    docker compose up -d db

  2. Enter Rails via Docker Compose. Run all other commands within this container!

    docker compose run --service-ports web /bin/bash

  3. Some dependencies might've changed from the last time you've worked on Flavortown. Doesn't hurt to check!

    bundle install

  4. It's time to cook! Run bin/dev!