/kindle_clippings_webapp

Web Application for importing, viewing and tagging kindle clippings. Account is not required.

Primary LanguageJavaScript

vscode-portfolio banner

Code style: prettier style: styled-components Build and Deploy codecov

Kindle Clippings Manager

About • What I Have Learned • Development • Deployment


Website: karlosos.github.io/kindle_clippings_webapp 🌐

About

Import Kindle Clippings and show them in accessible way. The app divides clippings into books and gives an option to delete and like highlights.

All functions:

  • import clippings
  • browse clippings
  • create backup and load from backup (saved to json file)
  • export all clippings from book to txt file
  • save application state in localStorage (app state is persistent)

What I Have Learned

This project was more goal oriented rather than education oriented. I wanted to have a simple application for managing my kindle clippings.

Development

You will need Node v16.13.1. I suggest using nvm for managing your node versions.

  1. Install dependencies with npm install.
  2. Run desktop application with npm run start or react app with npm run react-start.
  3. Access application under localhost:3000.

Code coverage can be checked using npm run test:coverage. Currently it is about 66%, mostly integration tests.

Deployment

Application is automatically deployed to GithubPages using .github/workflows/main.yml workflow.