Skip to content

Commit

Permalink
Update example env file and README.
Browse files Browse the repository at this point in the history
  • Loading branch information
sarmstead committed Nov 25, 2024
1 parent 125c070 commit 22058e1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ SMTP_PORT=1025
SMTP_DOMAIN=localhost
SMTP_ADDRESS=localhost
DB_PASSWORD=
G_RECAPTCHA_SITE_KEY=
G_RECAPTCHA_SECRET_KEY=
G_RECAPTCHA_SCORE_THRESHOLD=0.8
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Now, let's get you set up:

1. Install [Docker Desktop](https://docs.docker.com/desktop/) on your local machine. This allows you to run the database, Redis store, and [Mailpit](https://mailpit.axllent.org/) containers locally. You can, of course, skip this step if Docker's not your thing. Oh whale 🐳!
1. Pull down this repository to your local machine.
1. At the root of the project, run `cp .env.example .env`. Then slide on over to your new `.env` file and fill out the empty environment variables. If you're using Docker, feel free to put whatever you want for `SMTP_USERNAME`, `SMTP_PASSWORD`, and `DB_PASSWORD`.
1. At the root of the project, run `cp .env.example .env`. Then slide on over to your new `.env` file and fill out the empty environment variables. If you're using Docker, feel free to put whatever you want for `SMTP_USERNAME`, `SMTP_PASSWORD`, and `DB_PASSWORD`. Make sure to use reCAPTCHA v3 for all `G_RECAPTCHA_**` values. You can generate your own reCAPTCHA credentials at [https://www.google.com/recaptcha/](https://www.google.com/recaptcha/).
1. Open the Docker Desktop application. Then, in your termnial, run `docker compose up`. This will create and start the containers for PostgreSQL, Redis, and Mailpit.
1. In your terminal, run `bin/setup` to install your dependcies and set up your database.
1. In your terminal, run `bin/rails s` to fire up the development server.
Expand Down

0 comments on commit 22058e1

Please sign in to comment.