{"id":13341450,"url":"https://github.com/INRIA/aiana-player","last_synced_at":"2025-03-11T21:31:06.327Z","repository":{"id":44993847,"uuid":"140423664","full_name":"INRIA/aiana-player","owner":"INRIA","description":"Media player focusing on cognitive impairments. Formerly known as the \"Aiana Project\".","archived":false,"fork":false,"pushed_at":"2022-01-15T01:18:44.000Z","size":2853,"stargazers_count":6,"open_issues_count":17,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-06T13:44:43.122Z","etag":null,"topics":["a11y","media-player","mooc-player","web-accessibility"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/INRIA.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-10T11:44:02.000Z","updated_at":"2022-03-17T14:40:59.000Z","dependencies_parsed_at":"2022-08-23T18:10:22.442Z","dependency_job_id":null,"html_url":"https://github.com/INRIA/aiana-player","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INRIA%2Faiana-player","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INRIA%2Faiana-player/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INRIA%2Faiana-player/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INRIA%2Faiana-player/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/INRIA","download_url":"https://codeload.github.com/INRIA/aiana-player/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243115369,"owners_count":20238746,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["a11y","media-player","mooc-player","web-accessibility"],"created_at":"2024-07-29T19:25:26.250Z","updated_at":"2025-03-11T21:31:05.918Z","avatar_url":"https://github.com/INRIA.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aiana Web Player\n\n## What is Aiana\n\nAiana is a web media player meant to consume\n[MOOC](https://en.wikipedia.org/wiki/Massive_open_online_course) resources. It\nstarted as a research project at\n[Inria Bordeaux](https://www.inria.fr/centre/bordeaux) in the\n[POTIOC team](https://team.inria.fr/potioc/fr/). Its aim is to propose new\ndesign principles for MOOCs in order to let people with disabilities have a\nbetter experience when consuming the contents.\n\nThe player focuses on trying to improve the general MOOC experience for people\nwith cognitive impairments for whom accessibility standards are far from being\nestablished.\n\n---\n\n## How to Use it\n\nThere are two recommended ways to integrate the player when you want to use the\nmain channel releases.\n\n### Integrating the JavaScript Code to Your Web Pages\n\nThis integration lets you use your own JavaScript files and use your own servers\nto host it.\n\n1. Download the target version release archive.\n   [The \"Releases\" page](https://github.com/INRIA/aiana-player/releases/) is\n   where all archives can be downloaded from.\n\n2. Extract scripts so they can be accessed from your pages. For example,\n   `/public/js`, at the root of your web server.\n\n3. Add an element with `id=\"root\"` to your pages. The player will load its\n   content inside this element, so it is important that is remains empty, unless\n   of course you want to overwrite its content.\n\n4. Update your pages by adding `\u003cscript\u003e` tags to include the JavaScript files.\n\n[The Inria MOOC about digital accessibility](https://mooc-accessibility.inria.fr/course/)\ncourses are made this way and may be a good example to get started.\n\n#### Fallback\n\nTo provide content to the users who do not have JavaScript enabled, we recommend\nthat you use a `noscript` tag containing a `video` tag.\n\n`public/index.html` file does provide an example of what can be provided as a\nfallback.\n\n#### A Note About Styles\n\nNeeded styles are contained within the application using\n[styled components](https://www.styled-components.com/), and you should not need\nto override them.\n\n### Other Use Cases\n\nIf you intend on using this player in a native environment\n([React Native](https://facebook.github.io/react-native/)), please note that the\nplayer was not architectured to be used outside a web browser.\n\nIt may work, but some unexpected problems may happen and no support will be\nprovided.\n\n---\n\n## Development\n\n### Development Resources\n\nThis repository does not include development resources excepted the `index.html`\nfile and basic styles.\n\n[The development resources](https://static.bordeaux.inria.fr/mooc-accessibility/aiana-player-dev-resources.zip)\nare a set of static files sufficient to work offline and avoid network issues.\nSimply extract the archive and copy its `dev` directory in `public`.\n\nThe player configuration set in the `index.html` file expects to find these\nfiles and does not require any update.\n\n### Start Development Server\n\n1. Install development resources.\n\n2. Install `npm` dependencies:\n\n   `npm install`\n\n3. Run development server:\n\n   `npm run start`\n\n4. Go to `http://localhost:3000`.\n\n5. Follow the guidelines to start developing. You may find the following\n   resources handy:\n   - [React](https://reactjs.org/)\n   - [Create React App](https://create-react-app.dev/docs/getting-started/)\n   - [Cypress](https://www.cypress.io/)\n   - [Jest](https://jestjs.io/)\n\n## Create a Release\n\n### Test Build Locally\n\n```sh\nINLINE_RUNTIME_CHUNK=false npm run build\nrm -rf release\nmkdir release\nnode scripts/extract-scripts.js\n```\n\n### Continuous Integration\n\n[Travis CI](https://travis-ci.com) is used as continuous integration platform.\n\nWhenever a Git tag is pushed, Travis will perform tests and build an archive\ncontaining the files to be included in web pages.\n\nNote that due to a `react-scripts` limitation and the will to not `eject` the\nproject, a `manifest.yml` file is included to know what files are necessary to\nload the player.\n\nReleases can be found on\n[the project release page](https://github.com/INRIA/aiana-player/releases).\n\nNote that there is a\n[static link to the latest release](https://github.com/INRIA/aiana-player/releases/latest)\nwhich is used for website deployment.\n\n---\n\n## Project Documentation\n\n---\n\n## Code Status\n\n[![Build Status](https://travis-ci.com/INRIA/aiana-player.svg?branch=master)](https://travis-ci.com/INRIA/aiana-player)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FINRIA%2Faiana-player","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FINRIA%2Faiana-player","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FINRIA%2Faiana-player/lists"}