Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prx/metrics.prx.org
Dovetail podcast analytics frontend
https://github.com/prx/metrics.prx.org
Last synced: 16 days ago
JSON representation
Dovetail podcast analytics frontend
- Host: GitHub
- URL: https://github.com/prx/metrics.prx.org
- Owner: PRX
- License: agpl-3.0
- Created: 2017-05-24T16:38:41.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T21:16:02.000Z (about 1 year ago)
- Last Synced: 2024-04-09T18:30:44.112Z (9 months ago)
- Language: TypeScript
- Homepage: https://metrics.dovetail.prx.org
- Size: 2.55 MB
- Stars: 4
- Watchers: 11
- Forks: 0
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# metrics.prx.org
PRX Metrics Frontend App
This app is used to view podcast metrics.
# Install
## API and Backend Dependencies
### Use defaults
To set-up environment custom values, start with these defaults in your `.env` file:
```sh
cp env-example .env
vim .env
```
Metrics will connect to id-staging.prx.org, cms-staging.prx.tech, and your local Castle server.
### Use local `id`
To run id locally, change the `AUTH_HOST` in `.env` to `AUTH_HOST=id.prx.dev`.
### AUTH_CLIENT_ID for environment
Next, you will need to create a client application set up, this is easiest to do from the ID console:
```ruby
ssh to an instance running ID
# connect to ID's docker container
docker exec -it /bin/ash
# start a console for ID
./bin/application console
# in the console, save a new client application
client = Client.create(
:url => "http://metrics.prx.dev",
:callback_url => "http://metrics.prx.dev/assets/callback.html",
:support_url => "http://metrics.prx.dev",
:image_url => "http://s3.amazonaws.com/production.mediajoint.prx.org/public/comatose_files/4625/prx-logo_large.png",
:description => "metrics.prx.dev",
:template_name => "prx_beta",
:user_id =>8,
:name => "metrics.prx.dev",
:auto_grant =>true
)
client.key = SecureRandom.hex(40)[0..39]
client.secret = SecureRandom.hex(40)[0..39]
client.save
# get the client.key and set it as AUTH_CLIENT_ID
puts "Add this to .env"
puts "AUTH_CLIENT_ID=#{client.key}"
```
Enter in the client id in `.env`, setting `AUTH_CLIENT_ID` to the value from above.
### GOOGLE_API_KEY
You will need to get a Google API key for your .env for use with Google Geochart.
You can add one for your development environment under the project in the Google Cloud Platform API -> Credentials.
### GOOGLE_CLIENT_ID
You will need a Google Client Id for your .env for use with Google Sheets.
You can access this client id from the project in the Google Cloud Platform API -> Credentials.
## Local Install
Make sure you're running the node version in `.nvmrc`, and you're off!!
```sh
# install dependencies (https://yarnpkg.com/en/docs/install)
yarn install
echo 4202 > ~/.puma-dev/metrics.prx
# dev server
yarn start
open https://metrics.prx.dev
# run tests in Chrome
yarn test
```
The [prxproxy](https://github.com/PRX/internal/tree/master/guides/docker-for-mac#proxy-for-non-docker-development) nginx proxy is used for local development with ssl support. If using Firefox, you will need to add the certificate authority for the self signed certificates.
## Docker Install
Or if you really want to, you can develop via docker-compose.
This guide assumes you already have docker and dinghy installed.
```sh
# build a docker image
docker-compose build
# make sure your AUTH_CLIENT_ID is the .docker one
vim .env
# run the dev server
docker-compose up
# open up a browser to view
open http://metrics.prx.docker
```