recombiner
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.2%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: TeachBooks
- License: apache-2.0
- Language: TypeScript
- Default Branch: main
- Homepage: http://teachbooks.io/recombiner/
- Size: 3.61 MB
Statistics
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 2
- Releases: 0
Metadata Files
README.md
Teachbook recombiner
This is a web app to pick chapters from a pre-defined list of TeachBooks and combine them into a new book using
the new external table of content entry type, see the teachbook package.
Usage
You can visit the webapp at teachbooks.io/recombiner/. This has uses the default list of books from which you can select chapters. You can select the chapters you want to add you your own book, and either get instructions to follow yourself, or mail them to someone (e.g. the TA responsible).
By clicking on "Add a book" you can add a book that was not in the default list.
There are three ways to present a set of TeachBooks to others: - using the catalog (books.yml) and generating a new site using that. - using a remote catalog file and pointing to a running webapp. - adding books with the "Add a book" button, and sharing a hyperlink.
Catalog
In books.yml you can find the list of books that can be combined.
In chapters.json you can find the same books, but with their table of contents fetched. You should not edit this file manually, as it is generated by running the following command:
```bash
Install the dependencies, if you haven't already
pnpm install pnpm harvest
Reads books.yml and generates chapters.json
``` See the development instructions for more info on the dev setup.
Remote catalog
If you want to show other books the then ones specified in the ./books.yml file, you can point the app to a remote
catalog file with the following steps
1. Create a books.yml file
2. Host it on the Internet and make sure that CORS is enabled.
3. Open app with http://teachbooks.io/recombiner/?books_url=<your_url>. Where <your_url> is the URL of your books.yml file.
Sharing user defined books
In the web application you can add a book using a form.
To make those books shareable, you can click the share button in header of the books list.
This will open a new window with a link in the adress bar.
Sharing that link will allow other users to see the books you defined.
Develop
Developing this webapp requires Node.js and pnpm.
Once you've installed these you can use the following commands;
```bash
Install dependencies
pnpm install
Start the development server
pnpm dev
Run formatter and linter in fix mode
pnpm format
Run linter
pnpm lint
Run type checker
pnpm typecheck
Build the app
pnpm build
Preview the built app
pnpm preview ```
Owner
- Name: PSOR Books
- Login: TeachBooks
- Kind: organization
- Email: books-CEG@tudelft.nl
- Location: Netherlands
- Repositories: 1
- Profile: https://github.com/TeachBooks
Teachers’ Educational Assistance for interaCtive Hands-on Browser-based Online Open Knowledge for Students
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: Teachbook recombiner
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
-
affiliation: "Netherlands eScience Center"
family-names: Verhoeven
given-names: Stefan
orcid: "https://orcid.org/0000-0002-5821-2060"
-
affiliation: "Netherlands eScience Center"
family-names: Schilperoort
given-names: Bart
orcid: "https://orcid.org/0000-0003-4487-9822"
repository-code: 'https://github.com/TeachBooks/recombiner'
url: 'https://teachbooks.io/'
abstract: >-
Web app to pick chapters from a pre-defined list of teach
books and combine them into a new book
license: Apache-2.0
GitHub Events
Total
- Issues event: 10
- Delete event: 5
- Issue comment event: 26
- Push event: 8
- Pull request review event: 1
- Pull request event: 7
- Create event: 4
Last Year
- Issues event: 10
- Delete event: 5
- Issue comment event: 26
- Push event: 8
- Pull request review event: 1
- Pull request event: 7
- Create event: 4