Skip to content

Latest commit

 

History

165 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Reading Notes for Kindle

Buy Me A Coffee

📚 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. Build the web image: docker compose build web
  3. Start the database: docker compose up -d database_default
  4. Wait for PostgreSQL: docker compose exec -T database_default sh -c 'until pg_isready -U postgres -d db; do sleep 1; done'
  5. Run migrations: docker compose run --rm web python manage.py migrate
  6. Create superuser: docker compose run --rm web python manage.py createsuperuser
  7. Start the server: docker compose up web
  8. Configure Django CMS apphook (see below)

If you started web before running migrations and see relation "django_site" does not exist, run the migration command above and restart web.

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

About

📚 Web application for managing your kindle highlights

Topics

Resources

Stars

168 stars

Watchers

5 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages