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
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:
- 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.
https://user-images.githubusercontent.com/9143339/159093687-6fc90733-0599-445c-b08b-a6378d988e4b.mov
Codespaces Set Up
Contributing
Would you like to become a contributor? Please check out our contributors guide! 💝
Run the following script first:
script/bootstrapYou 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 .envCompiles and hot-reloads full app for development
npm run devCompiles and minifies for production
npm run buildLints and fixes files
npm run lintRuns Prettier and fixes files
npm run formatBuild and run as if in prod
npm startCustomize configuration
App Walkthrough
App Structure
Current Structure:
Goal Structure:
User Journey:
https://user-images.githubusercontent.com/9143339/159093855-c01e1d77-0d6a-4f6e-b691-81491830001a.mp4