Skip to content

Repository files navigation

Logo

RoamEdge

License Java 21 JavaFX 21 Repo Size Stars Forks

RoamEdge is a high-end, locally-stored productivity application built with Java 21 and JavaFX 21. It integrates a daily journal, a versatile knowledge base (Wiki), a comprehensive task management system, and a modern calendar – all connected by a lightning-fast Lucene-powered search engine.

📸 Showcase

RoamEdge Dashboard Overview RoamEdge Calendar View

RoamEdge Wiki Editor RoamEdge Task Manager RoamEdge Journal Entry

RoamEdge Global Search RoamEdge Settings and Themes

✨ Key Features

  • 📅 Integrated Calendar: Plan your schedule with persistent events and iCal support.
  • 📓 Daily Journaling: Markdown-powered daily notes with templates and quick look-back features.
  • 🧠 Knowledge Base (Wiki): Organize your knowledge with multi-level wikis, Markdown editing, and file attachments.
  • Task Management: Advanced task tracking with statuses, priorities, and cross-module filtering.
  • 🚀 Global Search: Instantly find anything across all modules using the Ctrl+K command palette (powered by Apache Lucene).
  • 🎨 Modern UI: A premium experience using the AtlantaFX theme, Poppins typography, and smooth micro-animations.
  • 🔒 Security First: All data is stored locally on your machine. Optional PIN-protected lock screen with BCrypt encryption.

🛠️ Technology Stack

  • Frontend: JavaFX AtlantaFX
  • Backend: Java Hibernate
  • Database: H2 (Local storage)
  • Search: Apache Lucene
  • Build System: Gradle

🏗️ Getting Started

Prerequisites

  • Java Development Kit (JDK) 21 or higher.
  • (Optional) Gradle (the project includes gradlew for local builds).

Building from Source

  1. Clone the repository:

    git clone https://github.com/mokaarom/roamedge.git
    cd roamedge
  2. Run the application locally:

    ./gradlew run
  3. Build a distribution:

    ./gradlew installDist

📂 Project Structure

  • src/main/java: Core application logic (MVC + Service Layer).
  • src/main/resources: UI assets, styles (CSS), icons, and fonts.
  • src/test: Integrated testing suite with JUnit 5 and Mockito.

🤝 Contributing

Contributions are welcome! If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are open to everyone.

  1. Fork the Project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your Changes (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

⚖️ License

Distributed under the APACHE License. See LICENSE for more information.


About

A high-end, locally-stored productivity application

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages