A collaboration between The Software Sustainability Institute and Seme4 looking at sameAs Lite.
The aims of the collaboration are as follows.
Open source project review: A report with recommendations on:
- How openness and community engagement can be supported.
- Licencing options e.g. MIT licence or GPL, Apache or BSD, dual licencing etc.
Deployer and developer requirements: A short summary of what resources are needed to review sameAs Lite from a deployer and a developer perspective (e.g. installation instructions)
Deployer experience review: A report on experiences of downloading and deploying sameAs Lite with recommendations as to how deployment can be improved.
Developer experience review: A report on experiences of setting up a local development/build/test environment for working on sameAs Lite with recommendations on:
- How the developer experience of sameAs Lite can be improved.
- How best to host the core and application functionality - in a single repository, as at present, or in two repositories.
- How to ensure developers do not degrade the performance of the core library.
- The importance of unit tests for third-party developers.
Database-agnostic core library design: A report on how the sameAs Lite core library could be refactored to be database agnostic, supporting both MySQL and SQLite, without degrading performance.
For more information, please see the Institute's "who do we work with - Seme4" page.
Reports:
- Open source project review
- Deployer and Developer Review
- REST API review
- Source code review
- Database-agnostic design
- Sample code relating to the above are in branches of https://github.com/softwaresaved/sameas-lite.
Sample documentation:
- sameAs Lite concepts - sameAs Lite concepts and database schema.
- Deployer's Guide
- Set up development environment
- Day-to-day development
- Deployer and Developer Reference - useful operating system-specific information for both deployers and developers.
- REST API examples - examples of invocations of sameAs Lite REST endpoints, and examples of what they return, which can be useful for deployers and developers.