Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 2.46 KB

README.md

File metadata and controls

62 lines (44 loc) · 2.46 KB
Raw

app icon Jotsy: Just your notes

Jotsy is a self-hosted, free and open-source note taking app with a goal of simplicity in mind. It is powered by Skytable. Read the full blog post here.

App Login page Signup page
app app app

🚧 This is currently under development

Features

  • 🏢 Multi-user
  • ✍️ Effective and distraction free notemaking
  • 🖋 Plaintext or markdown
  • 🔐 Secure authentication and session management
  • 🌱 Extremely simple to self-host
  • 🌲 Extremely light on resources
  • 🍃 Extremely lightweight on the browser
  • ⚒️ Simple configuration (read more here)

Getting started

  1. First, install docker-compose by following the instructions here
  2. Run this: 
    mkdir jotsy && cd jotsy && wget https://raw.githubusercontent.com/ohsayan/jotsy/next/docker-compose.yml && sudo docker-compose up -d
  3. Open your browser and head to http://localhost:2022

If you're having issues, consider reading the configuration guide.

Updating to the latest release

To update to the latest release (don't worry, you won't lose any data), run this:

cd jotsy && sudo docker pull ohsayan/jotsy:latest && sudo docker-compose up -d

This will pull the latest Jotsy image, stop the existing instance, rebuild the container and start it up again.

Stack

  • Backend:
    • Database: Skytable
    • Language: Rust
    • Framework/tools:
      • Tokio: Asynchronous runtime
      • Axum: A web framework built on top of Tokio
  • Frontend:
    • CSS Framework: Bootstrap
    • Scripting: Pure JavaScript (uses AJAX)
    • Markup: Pure HTML

Contributing

As highlighted in the original blog post, please create issues for any ideas you have; I want to hear them! Want to collaborate (would love some frontend wizard for some help :P)? Shoot me a DM on Twitter.

License

This app is distributed under the Apache-2.0 License.