A web site (bloomlibrary.org) for sharing literacy materials, especially templates for translation into minority languages.
Language speakers find books in their own language, and book creators find shellbooks to translate. They upload these to share them with the world.
You'll need nodejs and yarn. Please install volta so that you automatically use the correct version of nodejs and yarn that this project requires, as specified in package.json.
Finally, run yarn in a command line (e.g. in VSCode) to install the library dependencies.
To run the site locally, do yarn dev
To see various components/scenarios, do yarn storybook
To run the unit tests, do yarn test
BloomLibrary talks to a Parse server to get the list of books. This can be the Production Parse server, or the Development Parse server, or a locally hosted Parse server. You can manually change which server it talks to if needed. See ParseServerConnection.ts.
See details in src/translations/README.md.
BloomLibrary depends upon on the bloom-player library to provide the book reading experience. This is installed as a normal dependency. However, sometimes during the development process you may wish to run your own local build of bloom-player.
If you need to do that, there are a couple options:
One option is to yarn link (docs) to the local bloom-player source code on the same computer.
Another option is to manually copy the bloom-player's /dist folder build to BloomLibrary's node_modules/bloom-player/dist.
We use YouTrack Kanban boards.
Each time code is checked in, an automatic build begins in Github Actions, running all the unit tests.
Bloom is open source, using the MIT License. It is Copyright SIL Global. "Bloom" is a registered trademark of SIL Global.