Skip to content

Commit

Permalink
Merge pull request #36 from codeforamerica/update-readme-dev-setup
Browse files Browse the repository at this point in the history
Update README development environment setup instructions
  • Loading branch information
spokenbird committed Feb 9, 2024
2 parents 608485e + c44ffcb commit a378904
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,22 @@ $ createuser -s mdbenefits
$ createuser -s mdbenefits_test
```

IntelliJ should prompt you to add configurations for the two databases. If not, you can add them
manually by going to the Database tab and adding a new data source. Select localhost as the host for
both, and the default port for PostgreSQL is 5432. Choose no authentication for both.

## Setup IntelliJ and EnvFile
Note that you'll need to provide some environment variables specified in [sample.env](sample.env) to
your IDE/shell to run the application. We use IntelliJ and have provided setup instructions for
convenience.

- `cp sample.env .env` (.env is marked as ignored by git)
- Download the [EnvFile plugin](https://plugins.jetbrains.com/plugin/7861-envfile) and follow the
setup instructions [here](https://github.com/Ashald/EnvFile#usage) to setup Run Configurations with
setup instructions [here](https://github.com/Ashald/EnvFile#usage) to set up Run Configurations with
EnvFile.

You'll find the actual values you should use for the keys in the sample.env file in the shared LastPass.

### Setup Live Templates

- Use instructions from
Expand Down
18 changes: 16 additions & 2 deletions sample.env
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
# environment, where we will pull the form-flow library jar in it's publish version.
# If set to `dev` we will use the locally compiled form-flow library as specified in the build.gradle file.
SPRING_PROFILES_ACTIVE=dev
DEFAULT_LOCALE=en

#######################################################################################
# Cloud repository configuration
Expand All @@ -30,10 +31,23 @@ SPRING_PROFILES_ACTIVE=dev
# be populated, but not both. Other AWS fields are populated in the application.yaml file.
AWS_ACCESS_KEY=
AWS_SECRET_KEY=
AWS_BUCKET=

ENCRYPTION_KEYSET=
SMARTY_AUTH_ID=
SMARTY_AUTH_TOKEN=

MAILGUN_ID=
MAILGUN_KEY=

#######################################################################################
# The below are placeholders for not yet used configurations
#######################################################################################

CLAMAV_URL=
DEFAULT_LOCALE=
AWS_CMK=
MIXPANEL_API_KEY=
DEFAULT_LOCALE=en
ENCRYPTION_KEYSET=
SENTRY_DSN=''

# Mailgun
Expand Down

0 comments on commit a378904

Please sign in to comment.