https://github.com/nypublicradio/nypr-newsletter-signup

a simple, configurable, embeddable signup for for mailchimp and possibly other newsletter providers
https://github.com/nypublicradio/nypr-newsletter-signup

Last synced: about 1 month ago
JSON representation

a simple, configurable, embeddable signup for for mailchimp and possibly other newsletter providers

• Host: GitHub
• URL: https://github.com/nypublicradio/nypr-newsletter-signup
• Owner: nypublicradio
• Created: 2017-11-17T19:51:32.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:19:21.000Z (almost 2 years ago)
• Last Synced: 2024-04-10T20:53:18.839Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.77 MB
• Stars: 0
• Watchers: 6
• Forks: 2
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
 # NYPR Newsletter Signup

This is a simple form widget to subscribe users to a newsletter. Currently configured strictly for mailchimp lists.

## This is a toolkit module

This is a module designed to be used with [nypr-toolkit](https://github.com/nypublicradio/nypr-toolkit). See [that readme](https://github.com/nypublicradio/nypr-toolkit#development) for details on setting up a toolkit instance to work with modules.

## Development

This is a React app, bootstrapped with [`create-react-app`](https://github.com/facebookincubator/create-react-app), which includes a testing framework and build tools.

First, clone this git repo

```

$ git clone https://github.com/nypublicradio/nypr-newsletter-signup.git

```

CD into the repo directory and install NPM modules

```

$ npm install

```

Make an env file. The sample file will include defaults to get you started.

```

$ cp .env.sample .env

```

Start a development server.

```

$ yarn start # or `npm start`

```

This will start a development server at http://localhost:3000. When it's running, a browser will open up at that address.

## Running Tests

* `yarn test` or `npm test`

## Deploying

Deployment is handled by circle. Commits to `master` will deploy to the demo environment (i.e. https://demo-apps.nypr.org/newsletter-signup). Tagged commits will deploy to the production environment.

## Environment Variables

Name | Description

--- |  ---

`AWS_BUCKET` | Destination bucket for deploys

`AWS_PREFIX` | Path prefix for deployed assets

`AWS_REGION` | AWS Region for infrastructure

`AWS_ACCESS_KEY_ID` | AWS access key id

`AWS_SECRET_ACCESS_KEY` | AWS secret access key

`REACT_APP_BUILD` | The build environment for the app. Either `demo` or `prod`.

`REACT_APP_THEMES` | The absolute URL of the themes bucket. Does not end in a trailing slash.