Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.18 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.18 KB
Raw

Bitcoin Transciption Review

This repo hosts the frontend for transaction review website. Transcripts are generated from TSTBTC, then sent to the transcrition review backend. You'll be able to see the results here.

In order to edit a transcript, you'll need to give auth permissions to access fork and repo and open a PR on your behalf (we did our best to minimize the requirements).

Getting Started

  1. Clone the repo
  2. Install dependencies
  3. Update environment variables
  4. Run the app

Installing

  1. Clone the repo
git clone
  1. Install dependencies
yarn
# or
npm install
  1. Update environment variables
cp .env.local.example .env.local

As mentioned above you'll need to need GITHUB_ID and GITHUB_SECRET if you aren't pointing this front end towards a hosted backend.

  1. Run the app
yarn dev
# or
npm run dev

If you are interested in running the backend app, checkout the build instructions there.