README.md

PivotalTracker ChangeLog

A React Application to display a beautiful Changelog for every release of your PivotalTracker projects

Get Started

1. System Requirements

• Globally installed node
• Globally installed YARN (Optional)

2. Installation

On the command prompt run the following commands

$ git clone [email protected]:afadil/pivotaltracker-changelog.git

$ cd pivotaltracker-changelog

$ yarn (preferred)
  or
  npm install

Environment variables

Export your PivotalTracker API access Key. See Pivotal API token to get your Key

$ export PIVOTAL_KEY=[YOUR_PIVOTAL_KEY_HERE]

$ cp .env.sample .env

Edit .env file (This file is not tracked by git) and Change REACT_APP_PROJECT_CODE with your PivotalTracker project ID

REACT_APP_PROJECT_CODE=1234567

3. Run

Launch the application and the proxy server

$ npm run dev

Ou

$ yarn dev