Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alloy-org/readwise
Amplenote Readwise integration
https://github.com/alloy-org/readwise
Last synced: 3 months ago
JSON representation
Amplenote Readwise integration
- Host: GitHub
- URL: https://github.com/alloy-org/readwise
- Owner: alloy-org
- License: mit
- Created: 2022-03-14T04:37:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T17:29:32.000Z (7 months ago)
- Last Synced: 2024-08-03T22:14:41.097Z (6 months ago)
- Language: JavaScript
- Size: 856 KB
- Stars: 5
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-readwise - readwise - Amplenote Readwise integration. (Tools / Amplenote)
README
# Ample-Readwise
Ample-Readwise is [Amplenote plugin](https://www.amplenote.com/help/developing_amplenote_plugins) that implements
Readwise-sync functionality desired by its author.
## What are we working on lately?
## Progress over last three months
## Installation
1. Clone this repo. `git clone [email protected]:alloy-org/readwise.git`
2. Install node and npm if you haven't already.
3. Run `npm install` to install the packages.
4. Copy `.env.example` to `.env` and fill in the environment variable for your OpenAI key
## Testing
Run `NODE_OPTIONS=--experimental-vm-modules npm test` to run the tests.
If it complains about jsdom being absent, run `npm install -D jest-environment-jsdom` and try again.
### Run tests continuously as modifying the plugin
```bash
NODE_OPTIONS=--experimental-vm-modules npm run test -- --watch
```
## Technologies used to help with this project
* https://esbuild.github.io/getting-started/#your-first-bundle
* https://jestjs.io/
* https://www.gitclear.com