Skip to content

Stageddat/shelter-web

Repository files navigation

Shelter is a cozy, secure and open-source web-based journal designed with privacy and end-to-end encryption. Your data stays yours, stored directly in your browser.

Built with SvelteKit, Web Crypto & ❤️.

Showcase gallery

Shelter web app home page: Shelter - app home page showcase Shelter editor with different themes built in: Shelter - theme showcase

More screenshots in SHOWCASE.md!

Features

  • Local-First Architecture: Works completely offline using IndexDB and Service Workers.
  • End-to-End Encryption (E2EE): All sensitive information is encrypted on the client using Web Crypto. No one can read its contents, not even us.
  • Battle-tested encryption: We implement robust and audited algorithms such as AES-GCM for encryption and PBKDF2 for key derivation.
  • No account required: No email, no server, no tracking. Just open the app and start writing.
  • No Vendor Lock-in: Your entries and notes belong to you. Export your entire library to standard open formats at any time (soon!).
  • Rich Text Editor: Write with formatting using a clean, distraction-free editor powered by Tiptap.
  • Themes: Choose the design you like best, from light and dark themes to community styles like Catppuccin, and many more on the way!
  • Multilingual: Officially available in English and Catalan. Thanks to the community, we also have translations into Danish, Spanish, and many other languages!
  • Open Source: Shelter is and always will be open source and free under the GNU AGPLv3 license.

Getting Started

Follow these steps to set up the project locally for development.

Prerequisites

  • Make sure you have Node.js (20.9 or higher) installed.
  • pnpm.

Installation

  1. Fork and clone the repository:
git clone https://github.com/stageddat/shelter-web.git
cd shelter-web
  1. Install dependencies:
pnpm install
  1. Run the development server:
pnpm run dev

Open localhost:5173 in your browser to view the local development server.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md before submitting a pull request.

Thank you to everyone who makes Shelter possible ❤️!
You can see the full list of people who have contributed to this project at shelter.cat/credits.

Shelter Contributors

License

This project is open-source and available under the GNU AGPLv3.

About

Cozy journal web-based app with E2EE and local-first architecture.

Resources

License

Contributing

Stars

7 stars

Watchers

1 watching

Forks

Sponsor this project

Contributors