README.md

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
• Project Setup
• Customize configuration
• App Walkthrough

Getting Started

This repo contains both the frontend and backend portions of the Amplify application.

The frontend code is stored in the src/ directory.

The backend (API) code is stored in the server/ directory.

Project Workflow:

Enablement Deck

• Overall Project Board
• Feature Breakdown
• OSS Architecture
• Wiki: API methods, Data Structures

Resources:

• We meet every Wednesday from 12-1 p.m. PT and Thursdays from 8-8:30 p.m. PT. Sign up for an orientation
• Try out our demo or review App Research

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.

onboarding.codespaces.mov

Codespaces Set Up

Contributing

Would you like to become a contributor? Please check out our contributors guide! 💝

Run the following script first:

script/bootstrap

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:

cp .env.example .env

Compiles and hot-reloads full app for development

npm run dev

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Runs Prettier and fixes files

npm run format

Build and run as if in prod

npm start

Customize configuration

See Configuration Reference.

App Walkthrough

App Structure

Current Structure:

Goal Structure:

User Journey:

GMT20220129-002704_Recording_as_1680x956.mp4