Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nypublicradio/radiolab-vue
https://github.com/nypublicradio/radiolab-vue
radiolab
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/nypublicradio/radiolab-vue
- Owner: nypublicradio
- License: agpl-3.0
- Created: 2022-03-01T20:51:38.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T16:22:23.000Z (3 months ago)
- Last Synced: 2024-10-23T22:41:25.464Z (3 months ago)
- Topics: radiolab
- Language: Vue
- Size: 7.75 MB
- Stars: 2
- Watchers: 11
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Radiolab Web Client
We recommend to look at the [Nuxt 3 documentation](https://v3.nuxtjs.org).
## Setup
This project expects
node version `16.14.2`
npm version 8.6.0
to install the npm version, run the following
npm install [email protected] -g
```bash
npm install
```
For more info on the nuxt release candidates see https://github.com/nuxt/framework/releases
in VS Code, use the following plugin for formatting. Be sure to install the older version 0.33.10:
https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar
## Create .env and .npmrc files
```bash
cp .env.sample .env
cp .npmrc.sample .npmrc
```
You will need to update the newly created .npmrc file and add your own personal access token at the end of line 2. You can create one in github under settings -> developer settings -> personal access tokens
## Development
Start the development server on `http://local.dev.nypr.digital:3000`
```bash
npm run dev
```
To avoid a CORS error, be sure to replace `localhost:3000` with `local.dev.nypr.digital:3000`
## Production
Build the application for production:
```bash
docker build -t radiolab-vue .
docker run -p 3000:3000 -e HOST=0.0.0.0 radiolab-vue -e API_URL=https://api.demo2.wnyc.net
```
## Search Index
Keyword search and archive filtering is driven by the [Algolia](https://algolia.com/dashboard) search engine. Credentials for Algolia are in 1Password. Log in to the dashboard to view the indices (one for demo and one prod) as well as to retrieve the API keys, application ID and index name that will need to be set in the `.env` file. There is only one set of API credentials for both demo and prod, so make sure the index name is set appropriately (radiolab and Radiolab Demo). The indexer fetches episode data from the Simplecast API and sends it to Algolia. There are two options, one to do an update of the 10 most recent episodes another to rebuild the index from scratch. The refresh of recent episode is available via URL at `/api/update_index` and the full rebuild is available at `/api/all_index`. The full rebuild is only necessary if the index is corrupted or if the index is being moved to a new Algolia account. The update index is run from Zapier and triggered to run by a change in the Simplecast RSS feed for Radiolab. A token is needed to trigger both the update and all index, this is also in 1Password.