MOVED

This repo has been moved to a sub-package of https://github.com/ReadAlongs/Web-Component.

Please do not submit contributions here anymore!

Please do not use this version anymore!

ReadAlong-Studio Web

:construction: :construction: This project is moving to a monorepo, please don't do development on this repo. Instead, please go to https://github.com/ReadAlongs/Web-Component :construction: :construction:

Web application for audiobook alignment for Indigenous languages!

This project was generated with Angular CLI version 14.0.4. This web application is a web interface for end-to-end audio/text aligner. It is meant to be used together with the API from ReadAlong-Studio to assemble the text required for alignment.

Table of Contents

• ReadAlong-Studio Web
  • Table of Contents
  • Background
  • Data Sovereignty
  • Install
  • Usage
  • Development
  • Production
  • Maintainers
  • Contributing
  • Acknowledgements
  • How to Cite
  • License

See also: ReadAlong-Studio documentation.

Background

This web application is intended to be a graphical version of the ReadAlong Studio command line interface for creating interactive "read-alongs".

Data Sovereignty

We have built the tool with Indigenous data sovereignty in mind (see here for more info). As such, we are using the JavaScript version of soundswallower which runs on the users' computer without uploading audio to a server. Text data will be sent (encrypted) to the ReadAlongs API but is not stored or saved to disk on the server and is only used for creating the ReadAlong.

Installing

You must have Node installed (v16 preferred), then run npm install from the repo root.

Usage

Development

Run npm start or ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.

To see the French version you may run ng serve --configuration=fr. Other translations are always welcome!

The ReadAlongs/Studio web API must also be running locally on port 8000 for the app to work in dev mode: clone https://github.com/ReadAlongs/Studio.git, cd into Studio/readalongs and launch the web API with PRODUCTION= uvicorn readalongs.web_api:web_api_app --reload (see Studio/readalongs/web_api.py for details).

Production

Run npm run-script build:prod to build the project. The build artifacts will be stored in the dist/ directory.

Maintainers

@roedoejet.

Contributing

Feel free to dive in! Open an issue or submit PRs.

This repo follows the Contributor Covenant Code of Conduct.

Acknowledgements

This work would not have been possible without the many collaborators who shared their expertise and recordings, including but not limited to the Yukon Native Language Centre, the Kitigan Zibi Cultural Centre, W̱SÁNEĆ School Board, the Pirurvik Centre, Conseil de la Nation Atikamekw, Onwkawenna Kentyohkwa, Owennatekha Brian Maracle, Timothy Montler, Marie-Odile Junker, Hilaria Cruz, Nathan Thanyehténhas Brinklow, Francis Tyers, Fineen Davis, Eddie Antonio Santos, Mica Arseneau, Vasilisa Andriyanets, Christopher Cox, Bradley Ellert, Robbie Jimmerson, Shankhalika Srikanth, Sabrina Yu, Caroline Running Wolf, Michael Running Wolf, Fangyuan (Toby) Huang, Zachery Hindley, Darrel Schreiner, Luyi Xiao, Siqi Chen, Kwok Keung Chung, Koon Kit Kong, He Yang, Yuzhe Shen, Rui Wang, Zirui Wang, Xuehan Yi, and Zhenjie Zhou.

Northeastern University collaboration

The design of the interface and CSS styling was developed by two group of students in Michael Running Wolf's Spring 2022 Foundations of Software Engineering course. We are very grateful for both groups' hard work and contributions. Group 1 developed the design that was eventually chosen for this project, as such we are grateful for the code contributions to this repository from Siqi Chen, Kwok Keung Chung, Koon Kit Kong, and He Yang.

Cite

If you use this tool, please cite it:

Littell, P., Joanis, E., Pine, A., Tessier, M., Huggins-Daines, D., & Torkornoo, D. (2022). ReadAlong Studio: Practical Zero-Shot Text-Speech Alignment for Indigenous Language Audiobooks. Proceedings of SIGUL2022 @LREC2022, 23–32.

@inproceedings{littellreadalong,
  title={ReadAlong Studio: Practical Zero-Shot Text-Speech Alignment for Indigenous Language Audiobooks},
  author={Littell, Patrick and Joanis, Eric and Pine, Aidan and Tessier, Marc and Huggins-Daines, David and Torkornoo, Delasie},
  year= {2022},
  booktitle = {{Proceedings of SIGUL2022 @LREC2022}},
  pages = {23-32}
}

License

MIT © 2022 National Research Council Canada