Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.55 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.55 KB

NYPR Call to Action

This is a simple text widget with a button linking out to an external URL.

This is a toolkit module

This is a module designed to be used with nypr-toolkit. See that readme for details on setting up a toolkit instance to work with modules.

Development

This is a React app, bootstrapped with create-react-app, which includes a testing framework and build tools.

To get started, 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/call-to-action). 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.