architecture
architecture copied to clipboard
Naming of the new web-based Reader repos
@rkwright wrote document about the EOL of the Chrome app here. As part of that it was proposed that the naming of the new repos be as follows:
New Repos
We will need four new repos corresponding to readium-js, readium-js-viewer, shared-js and cfi-js. One approach would be to pattern them of the existing names and the "r2" prefix used elsewhere. Thus:
| R1 Name | Readium-Web Name |
|---|---|
| readium-js-viewer | r2-js-viewer |
| readium-js | r2-js |
| readium-shared-js | r2-shared-js |
| readium-cfi-js | r2-cfi-js |
Each of these repos will be a clone of the existing repo, then modified by
- removing all code, build-scripts, resources, etc. related to the Chrome app
- adding new interfaces and APIs as appropriate
- modifying and/or adding tests in order to enable functional testing (e.g. continuous build processes such as on Travis)
@JCCR wrote: I'm looking at adopting new names for the "evolved" readium-js repos I've been working on.
If we are going by what's in your EOL doc.. I see a problem (https://github.com/readium/readium-js-viewer/wiki/EOL-for-ReadiumJS-and-BOL-for-Readium-Web#new-repos)
The shared code for the JS R2 streamer/navigator is called r2-shared-js already.
I propose we either rename the previous projects with some sort of -archived suffix readium-js-archived readium-js-viewer-archived
Rename it to something else: readium-js-old readium-js-legacy
Or use a different naming convention for the new packages: I'm currently in favour of a mono repo called r2-js-classic
Clearly, these new repos need to be named as a function of the outcome of the discussion in this thread.
Readium Web Repositories
r2-testapp-web
- Demo viewer application to showcase capabilities.
- Simple UI, nothing fancy.
- Can be built on its own with
r2-*projects published and pulled fromnpm.
r2-navigator-web
- What's going to be formed from Readium NG
- Can be built on its to just run the test suite.
r2-workspace-web
- Bootstrap a Readium web developer's workspace.
- Builds the
r2-testapp-webwith local versions ofr2-*projects:r2-navigator-webr2-shared-jsr2-utils-jsr2-glue-js