An API for accessing information related to meetings and publications of Jehovah's Witnesses.
Library API offers the following packages:
| Package | Description | Changelog |
|---|---|---|
| Library Media | A desktop app that makes sharing meeting media easy | View |
| Library Express | An express server for providing easy access to publication information | View |
| Library Core | Core tools used in other packages that can be used to build your own app | View |
Documentation for all packages can be viewed here.
There is no publicly available API for this information and the data structure is not created in a way to make things simple to parse or access.
These packages aim to provide an API that provides the information without having to dig into the internals of existing apps.
We also aim to provide sample applications that use this API.
For instructions on how to use the individual packages view them using the links above.
If you have any issues or feature requests please check if this had already been suggested on our issues page and if not then select "New issue".
If you would like to contribute then thank you in advance! Library API uses the following tools for development you will need to install:
- VSCode as an IDE, you should be prompted to install recommended extensions when first opening the project
- Yarn (Classic) for package management
You may also want to be familiar with the following (although some of these are automatic):
- TypeScript is the main language
- Husky is used to set up git hooks
- Commitizen and commitlint enforce commit message styling
Run the following commands to get started:
# Bootstrap project (install dependencies & build TS definitions)
yarn bootstrap
# Run a command in a certain workspace
yarn workspace [workspace] [command]
# For example to run `yarn dev` in the `express` workspace
yarn workspace @library-api/express dev
# Shortcuts exist for the main packages, this is equivalent to the above
yarn express dev