Merge branch 'main' into contributing-documentation

Author: paramsiddharth

.env.example

@@ -2,9 +2,9 @@
 #   Example `.env` file   #
 ###########################
 
-# API key for the Google Civic API
-# See https://github.com/ProgramEquity/amplify/blob/main/.github/CONTRIBUTING.md#using-the-google-civic-information-api-locally
-CIVIC_API_KEY=
+# API key for the Cicero API
+# Check with the team leads for the latest Cicero API key to be used
+CICERO_API_KEY=
 
 # Production environment API key for the Lob API
 # This value can be found in Heroku application config var of the same name
@@ -28,4 +28,4 @@ STRIPE_SECRET_KEY=sk_test_51IravfFqipIA40A3FOW6EzlXlJiXjL9V0FXKfb9n7cxh25Ww9QMA9
 # To run in single-campaign mode, set the following environment vars
 VUE_APP_CAMPAIGN_MODE = "single" # or "default" for normaal operation
 VUE_APP_FEATURED_CAMPAIGN = "5" # campaign's id from Postgres
-VUE_APP_LETTER_TEMPLATE = "" # the template associated with the featured campaign
+VUE_APP_LETTER_TEMPLATE = "" # the template associated with the featured campaign

.eslintrc.json

@@ -7,7 +7,8 @@
   },
   "extends": ["eslint:recommended", "prettier"],
   "parserOptions": {
-    "ecmaVersion": 12
+    "ecmaVersion": 13,
+    "parser": "@babel/eslint-parser"
   },
   "rules": {},
   "ignorePatterns": ["/dist/**/*.js"]

.github/mention-to-slack.yml

@@ -24,3 +24,9 @@ LoopFruits: 'U03A63J8U4V'
 ericvennemeyer: 'U04354QA2K0'
 sammychinedu2ky: 'U042T8UV7GF'
 JoseEspinosaMachado: 'U043XLVG5R9'
+Alex-is-Gonzalez: 'U04NASJJ5R6'
+rsensenig: 'U04LD85GHDH'
+SAUMILDHANKAR: 'U04MG19LM7G'
+beverand: 'U04M9E6CXHS'
+yoyoyojoe: 'U04LSCZPGF9'
+christina-ml: 'U04M0BU9GCE'

.github/workflows/welcome_message.yml

@@ -0,0 +1,21 @@
+name: 'Welcome New Contributors'
+
+on:
+  issues:
+    types: [opened]
+  pull_request_target:
+    types: [opened]
+permissions:
+  issues: write
+  pull-requests: write
+jobs:
+  welcome-new-contributor:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: 'Greet the contributor'
+        uses: garg3133/welcome-new-contributors@a38583ed8282e23d63d7bf919ca2d9fb95300ca6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-message: 'Hello there, thanks for opening your first issue. We welcome you to the community!'
+          pr-message: 'Hello there, thanks for opening your first Pull Request. Someone will review it soon.'

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+team@programequity.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.md

@@ -1,5 +1,7 @@
 # Amplify
 
+Amplify is an open-source app created for users to take the initiative in being part of an actionable step in the efforts to protect against climate change. The user is able to choose a climate campaign, then using their zip code, they will be able to select a representative of their choice. The user then donates to have their letter sent out by Amplify.
+
 ## Table of Contents
 
   * [Getting Started](#getting-started)
@@ -15,8 +17,6 @@ The frontend code is stored in the `src/` directory.
 
 The backend (API) code is stored in the `server/` directory.
 
-
-
 **Project Workflow:**
 
 [Enablement Deck](https://docs.google.com/presentation/d/1llJgeTU1EzRSYB8kL-IQeAdoq7p6xb4ApEac5E3M8Qo/edit?usp=sharing)
@@ -29,22 +29,30 @@ The backend (API) code is stored in the `server/` directory.
 - [Wiki](https://github.com/ProgramEquity/amplify/wiki): API methods, Data Structures
 
 **Resources:**
-- We meet every **Wednesday from 12-1 pm pt and Thursdays from 8-8:30 pm pt**. Sign up for an [orientation](https://forms.gle/4miQJ8ccuWdeJha16)
+- We meet every **Wednesday from 12-1 p.m. PT and Thursdays from 8-8:30 p.m. PT**. Sign up for an [orientation](https://forms.gle/4miQJ8ccuWdeJha16)
 - Try out our [demo](https://www.figma.com/file/46c9cmuTiCpFA4DHB8OK0H/Amplify-User-Interface-%2B-Design-Guide?node-id=1585%3A653) or review [App Research](https://www.notion.so/programequity/Dare-to-Dream-Civic-Engagement-is-key-to-change-595ca4db3a2948c6b44569b58d530c8c)
 
 
 
-## Project setup
+# Project setup
+In order to get started, you can clone, download a ZIP, or fork this repository to work on your local machine. If you would like to get started with Codespaces instead, the video below will walk you through setting up your Codespace.
 
 https://user-images.githubusercontent.com/9143339/159093687-6fc90733-0599-445c-b08b-a6378d988e4b.mov
 
+<b>Codespaces Set Up</b>
+
 ## Contributing
 Would you like to become a contributor? Please check out our [contributors guide](.github/CONTRIBUTING.md)! 💝
 
+Run the following script first:
 ```shell
 script/bootstrap
 ```
-You will need to copy the `.env.example` file to a `.env` file in this repo.
+
+You will need to copy the `.env.example` file to a `.env` file in this repo. You can use the following command in your terminal:
+```shell
+cp .env.example .env
+```
 
 ### Compiles and hot-reloads full app for development
 ```shell
@@ -61,6 +69,12 @@ npm run build
 npm run lint
 ```
 
+### Runs Prettier and fixes files
+```shell
+npm run format
+```
+
+
 ### Build and run as if in prod
 ```shell
 npm start
@@ -69,7 +83,7 @@ npm start
 ### Customize configuration
 See [Configuration Reference](https://cli.vuejs.org/config/).
 
-## App Walkthrough
+# App Walkthrough
 
 **App Structure**
 
@@ -87,6 +101,7 @@ Goal Structure:
 https://user-images.githubusercontent.com/9143339/159093855-c01e1d77-0d6a-4f6e-b691-81491830001a.mp4
 
 
+
 <img width="1561" alt="Screen Shot 2021-11-11 at 1 51 44 PM" src="https://user-images.githubusercontent.com/9143339/141374196-a32d140f-885c-4e45-8bba-99696f81ee80.png">