Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 4.01 KB

README.md

File metadata and controls

80 lines (62 loc) · 4.01 KB

Important

We have problems with our deployed service, and I'm now working on it. In the meantime, you can easily fork and deploy your own :) -ayo

Cozy

Last Commit Alpha Version
Remove distractions. Save for later.
Cozy is your modern-day reading assistant.


How is this app different?

Here's what this project is building:

  1. An app that just works, no sign-ups or set-ups.
  2. Progressively enhanced experience. Main feature works even without JS. Removing distractions happen on the server and dead clean HTML gets delivered
  3. All your data are cached and does not leave your device; offline access is by default
  4. Cloud-sync will be opt-in, with your choice of provider
  5. Will also explore smart insights, such as:
    1. text summarization
    2. dominant emotion
    3. other sources for lateral reading

Roadmap

Feature Status Version
Remove distractions ✅ DONE v0.0.x
Save viewed history ✅ DONE v0.1.x
Open links within Cozy ✅ DONE v0.2.x
Set items as Favorites 🛠️ In-progress v0.3.x
PWA: full Offline access v1.0.x
Smart insights v1.1.x
Browser Extensions
Native Apps

Usage / Options

1. Copy, Paste

It's simple. When you open an article and want to turn it into a more cozy reading experience, just copy the url and paste it to the app's address bar.

2. One-click Bookmark

A bookmarklet could run a script to open the current page for you on Cozy. You can create this new bookmark titled 'Get cozy!' and put the following as value for the URL:

Warning

This is not working, until we fix our deployed service

javascript:(function(){ window.open('https://cozy-reader.vercel.app/?url=%27 + window.location.href, %27_self%27); })();

This is possible on all major browsers, including Safari on iOS (where I personally use this often). Some screenshots:

Firefox Chrome
Screenshot from 2023-05-13 08-31-41 Screenshot from 2023-05-12 23-32-08

3. One-click Extension then...

It doesn't exist yet... I'll probably get to creating a browser extension at some point. But for now, PRs welcome! :)

Credits

We are thankful for all the building blocks provided by the following projects:

  1. Astro for our server-side rendering framework
  2. @astrojs/prefetch for our experimental prefetch strategy (not sure if working yet 🤣); only while we don't have a more aggressive prefetch-and-cache strategy
  3. @ayco/astro-resume for communicating necessary data from server to client
  4. @extractus/article-extractor for the amazing scraping of articles
  5. astro-iconify for easily icon-sets in iconify
  6. sass for some nested styling
  7. ultrahtml for any cleanup and transformation we do on the received article content

Contributing

If any of the above seems to need improvement for you, we are always eager to hear feedback and welcome all contributions. See our CONTRIBUTING guide for more info.

Join our Discord if you need help!