📚 Readr - Turn pages into progress

Minimal, offline-first reading log with JSON backup/import, security policy, and contributor-friendly docs.

🔗 Full Documentation →

---

Live Demo

▶ Try it now: https://conorgregson.github.io/reading-log-app/

Data is saved locally in your browser via localStorage and is separate from your local dev data.

---

📑 Table of Contents

• About
• Features
• Tech Stack
• Roadmap
• Installation & Usage
• Screenshots
• Contributing
• Author
• License

---

ℹ️ About

Readr is a lightweight, browser-based reading log. Built with vanilla JavaScript, HTML, and CSS, it helps you track your books without external accounts, sync, or setup.

---

✅ Features

• Add, edit, and remove books from your log
• Track reading progress and completion status
• Backup and import your log with JSON
• Data persistence with localStorage

---

🛠️ Tech Stack

• Frontend: HTML, CSS, Vanilla JS
• Storage: LocalStorage + JSON import/export

---

🗺️ Roadmap

See the full Roadmap for milestones and timelines.

---

🚀 Installation & Usage

1. Clone the repository

   git clone https://github.com/conorgregson/reading-log-app.git
   cd reading-log-app

2. Open the app Simply open the index.html file in your browser.

   • No build steps or dependencies required.
   • Works entirely offline with localStorage.

3. Start using the app

   • Add, edit, or remove books from your log.
   • Track your reading progress and completion.
   • Backup and import your log as JSON files

---

📸 Screenshots

Updated for v1.6.0 — Search & Filters

Main UI

Goals & Sessions

Books List (populated)

Bulk Edit Dialog

Dark Mode

Settings Dropdown

Search & Filters

Multi-Select Filters

Saved Searches

Search Results Example

Installed App View

---

📖 Documentation

Full project documentation is available in the /docs folder:

• Getting Started — installation & usage
• Features — current and planned features
• Design Decisions — architecture choices & trade-offs
• Roadmap — milestones & timelines
• Troubleshooting — common issues & fixes
• Brand Assets — logos, color, usage guidelnes
• Progressive Web App (PWA) — install guide, offline features, roadmap

---

🤝 Contributing

Contributions, issues, and feature requests are welcome!

• Check the issues page
• Open a pull request with improvements

Quick start for contributors:

1. Fork the repo
2. Create your feature branch (git checkout -b feature/my-feature)
3. Commit your changes (git commit -m "feat: add my feature")
4. Push to branch (git push origin feature/my-feature)
5. Open a Pull Request

---

📧 Author

Made by Conor Gregson

• GitHub
• LinkedIn

---

📜 License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the LICENSE file for details