-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
383 additions
and
171 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,9 +10,10 @@ Activist Database Project | |
|
||
The following dependencies are required to run this project and will be already | ||
installed if using the devcontainer: | ||
* go | ||
* node.js v16 | ||
* docker | ||
|
||
- go | ||
- nvm | ||
- docker | ||
|
||
Running this command is required to download all the go and node dependencies: | ||
|
||
|
@@ -31,6 +32,7 @@ make dev_db | |
``` | ||
|
||
If you are using the devcontainer, just run this command in the container: | ||
|
||
```bash | ||
make dev_db | ||
``` | ||
|
@@ -65,12 +67,12 @@ This project uses webpack to compile our frontend files. Frontend | |
files that need to be compiled are in `frontend/`, and the compiled | ||
outputs are in `frontend/dist/`. | ||
|
||
* package.json: file with all frontend dependencies | ||
- package.json: file with all frontend dependencies | ||
|
||
* webpack.config.js: configuration file for webpack, which builds the js | ||
- webpack.config.js: configuration file for webpack, which builds the js | ||
|
||
* `make watch`: watch the frontend folder for changes and | ||
automatically build the file if anything changes. | ||
- `make watch`: watch the frontend folder for changes and | ||
automatically build the file if anything changes. | ||
|
||
The most convenient workflow is to run `make watch` in one terminal | ||
and `make run` in another one. Then your JS changes will automatically | ||
|
@@ -93,35 +95,43 @@ be built as you edit them. | |
## Optional environment variables | ||
|
||
### For signing people up to DxE's main mailing list & chapter-specific mailing lists (please reach out to [email protected] to get an API key to sign people up) | ||
|
||
- SIGNUP_ENDPOINT | ||
- SIGNUP_KEY | ||
|
||
### For syncing with a chapter's internal Google Groups (for example, working group lists): | ||
|
||
- SYNC_MAILING_LISTS_CONFIG_FILE: relative path to client_secrets.json if syncing with google groups | ||
- SYNC_MAILING_LISTS_OAUTH_SUBJECT: google account to use to sync | ||
|
||
### For sending emails via SMTP: | ||
|
||
- SMTP_HOST | ||
- SMTP_PORT | ||
- SMTP_PORT | ||
- SMTP_USER | ||
- SMTP_PASSWORD | ||
|
||
### For sending surveys to event attendees: | ||
|
||
- SURVEY_FROM_EMAIL | ||
- SURVEY_MISSING_EMAIL: Email to send survey errors to | ||
|
||
### Google Cloud client ID/secret for the Members page: | ||
|
||
- MEMBERS_CLIENT_ID | ||
- MEMBERS_CLIENT_SECRET | ||
|
||
### ipgeolocation.io key for finding nearby upcoming events based on a user's IP address (used w/ public-facing API): | ||
|
||
- IPGEOLOCATION_KEY | ||
|
||
### Discord config for verifying accounts: | ||
|
||
- DISCORD_SECRET | ||
- DISCORD_BOT_BASE_URL | ||
- DISCORD_FROM_EMAIL | ||
- DISCORD_MODERATOR_EMAIL | ||
|
||
### Google Places API Key for finding city information on public-facing forms | ||
|
||
- GOOGLE_PLACES_API_KEY |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.