{"id":16362536,"url":"https://github.com/colorfield/audioguide-demo-react","last_synced_at":"2026-05-01T02:34:55.778Z","repository":{"id":150261319,"uuid":"92723338","full_name":"colorfield/audioguide-demo-react","owner":"colorfield","description":"React web app for the Audioguide demo","archived":false,"fork":false,"pushed_at":"2018-01-16T21:49:35.000Z","size":1385,"stargazers_count":0,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-29T15:14:50.942Z","etag":null,"topics":["audio","drupal-8","json-api","mp3","react"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/colorfield.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-29T09:01:05.000Z","updated_at":"2017-12-08T09:04:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"65211933-8a29-41f4-a56d-a8a10bed00db","html_url":"https://github.com/colorfield/audioguide-demo-react","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/colorfield/audioguide-demo-react","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colorfield%2Faudioguide-demo-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colorfield%2Faudioguide-demo-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colorfield%2Faudioguide-demo-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colorfield%2Faudioguide-demo-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/colorfield","download_url":"https://codeload.github.com/colorfield/audioguide-demo-react/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/colorfield%2Faudioguide-demo-react/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32483406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audio","drupal-8","json-api","mp3","react"],"created_at":"2024-10-11T02:24:33.346Z","updated_at":"2026-05-01T02:34:55.768Z","avatar_url":"https://github.com/colorfield.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Audioguide\n\n## Getting started\n\n### Local Drupal configuration\n\nGet a copy of the production Drupal 8 website and define the CORS configuration in /admin/config/services/cors to \n`*|http://localhost:3000`\n\n### JSON API configuration\n\n1. Copy the src/constants/env.example.js into src/constants/env.js\n2. Set the JSON_API_URL with your API url.\n3. Optionally set the CONSUMER_ID with the one obtained by the [Consumers](https://www.drupal.org/project/consumers) Drupal module.   \n\nOn your local/dev environment, it will be the Url defined for your vhost, with the protocol.\n_Example: http://mysite.dev_\n\n### React Boilerplate setup\n\nOn MacOSX, get Yarn via Homebrew so it will be easily upgradable.\n\nCd in this repository then:\n\n`yarn install`\n\nThis will install both run-time project dependencies and developer tools listed in package.json file.\n\n`yarn start`\n\nThis command will build the app from the source files (/src) into the output /build folder. As soon as the initial build completes, it will start the Node.js server (node build/server.js) and Browsersync with HMR on top of it.\n\n`yarn run build --release`\n\nExports a production build (in the build directory).\n\n### Deployment\n\n1. Get the latest codebase `git pull`\n2. Install new dependencies if any `yarn install`\n3. Production build `yarn run build --release`\n4. Start or restart PM2 `pm2 start build/server.js` `pm2 restart build/server.js`\n\n### Storybook setup\n\n`yarn run storybook`\n\nStarts the UI component dev environment based on [Storybook](https://storybook.js.org/).\n\n## Production server\n\nApache proxy with [PM2](http://pm2.keymetrics.io/).\n\n## Nomenclature\n\n- Itinerary and Stop: an itinerary has several \"stops\". Example: The \"Adult\" itinerary has the \"The Maltese Falcon\" and \"You Only Live Once\" stops.\n- Answer: an optional answer that can be given by the user during a stop.\n\n## Drupal content model\n\nEach content entity is fully translatable via Drupal and exposed with JSON API.\n\n### Itinerary\n\nTaxonomy vocabulary, machine name: **itinerary**\n\n- Name (1)\n- Icon image (1)\n- Background image (1)\n- Formatted long text (0..1)\n\n### Stop\n\nContent type, machine name: **stop**\n\n- Title (1)\n- Identifier (1)\n- Image (1)\n- MP3 (1)\n- Formatted long text (0..1)\n- Itinerary (1..*)\n- Answer (0..*)\n\n### Answer\n\nParagraph, machine name: **answer**\n\n- Title (1)\n- Formatted long text (1)\n- MP3 file (1)\n\n## React Components\n\n### Top level component\n\n**App**\n\nThe default **Layout** component is only used as a wrapper and we could consider to remove it because\neach page has a different Header component.\n\n### Pages an routes\n\nReact components that will be available from routes.\n\n- / **ItineraryListPage**\n- /itinerary/:itinerary_id **ItineraryPage**\n- /stop/:itinerary_id/:stop_id **StopPage**: Stop detail page, with optional answer\n\n### Specific components, per page\n\n#### ItineraryListPage\n\n- ItineraryListHeader\n  - Link: About page link\n  - Logo: svg image\n  - LanguageSwitcher\n- ItineraryList\n  - ItineraryTeaser: link to an itinerary with: thumbnail image (?), icon, title\n\n#### ItineraryPage\n\n- ItineraryHeader\n  - Link: back to the itinerary list page.\n  - Image: (?)\n  - Title\n  - LanguageSwitcher\n- FilterableStopList\n  - SearchBar\n  - StopList\n    - StopTeaser: thumbnail image, id, title, mp3 length \n\n#### StopPage\n\n- StopHeader\n  - Link: back to the current itinerary stop list page.\n  - StopLocation: itinerary title and stop id (@todo)\n  - Title\n  - LanguageSwitcher\n- AudioPlayer: mp3, image, previous and next\n- Text\n- AudioQuiz\n  - AudioAnswer\n\n### Generic components\n\n- LanguageSwitcher\n- Link\n\n## React Starter Kit boilerplate\n\n- [README](./REACT_STARTER_KIT.md)\n- [Documentation](./docs/README.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcolorfield%2Faudioguide-demo-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcolorfield%2Faudioguide-demo-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcolorfield%2Faudioguide-demo-react/lists"}