https://github.com/mammuth/kindle-clippings
:books: Web application for managing your kindle highlights
https://github.com/mammuth/kindle-clippings
books django hacktoberfest kindle kindle-highlights python quotes reading
Last synced: 5 months ago
JSON representation
:books: Web application for managing your kindle highlights
- Host: GitHub
- URL: https://github.com/mammuth/kindle-clippings
- Owner: mammuth
- License: gpl-3.0
- Created: 2019-06-24T16:47:23.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2026-01-02T11:39:19.000Z (6 months ago)
- Last Synced: 2026-01-03T01:24:23.308Z (6 months ago)
- Topics: books, django, hacktoberfest, kindle, kindle-highlights, python, quotes, reading
- Language: JavaScript
- Homepage: http://reading-notes.com
- Size: 2.43 MB
- Stars: 163
- Watchers: 5
- Forks: 14
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Reading Notes for Kindle
:books: Reading Notes is a free and open source web application for maintaining your **Kindle Highlights**.
http://reading-notes.com
**Features:**
- Upload and search through your clippings
- Filter clippings by books
- **E-Mail delivery** of a random quote (daily, bi-weekly, weekly)
- **Exclude specific books** from email delivery
- Nerdy statistics about your clippings
- Page with a random quote (can be used as new-tab page or on wall-mounted screens).
## Contribute
Feel free to open issues or PRs!
This is a pretty simple django application with a good'ol HTML frontend generated by django. It's hosted on Divio.
#### Project setup
1. Copy environment file: `cp .env-local.example .env-local`
2. Start containers: `docker-compose up --build`
3. Run migrations: `docker-compose run --rm web python manage.py migrate`
4. Create superuser: `docker-compose run --rm web python manage.py createsuperuser`
5. Configure Django CMS apphook (see below)
#### Django CMS Apphook Configuration
After starting the server, you need to configure the Django CMS apphook for the app to work:
1. Go to `http://localhost:8000/admin/` and log in with your superuser account
2. Navigate to **CMS → Pages**
3. Click **"New Page"** and give it a title (e.g., "Reading Notes")
4. Save the page, then click on **"Advanced settings"**
5. In the **APPLICATION** dropdown, select **"Clipping Manager Application"**
6. Set **APPLICATION INSTANCE NAME** to `clipping_manager`
7. Save and **Publish** the page
8. The app is now accessible at the page URL (e.g., `/en/reading-notes/`)
#### Other commands
- manage.py commands can be executed as follows: `docker-compose run --rm web python manage.py migrate`
- Optionally configure the `EMAIL_URL` environment variable when you want to send mails
## Roadmap
- Integrate with more services than just Kindle
- Restful API for retrieving ones notes
- Export in various formats
- Slack Bot