Nebula is a lightweight, markdown-based note-taking app designed for developers. It prioritizes productivity and simplicity, featuring local file system storage and optional cloud sync integration (e.g., Dropbox, Google Drive).
- Markdown-Based Notes: Write, preview, and manage notes in markdown format.
- Local Storage: Notes are stored as plain markdown files on your device's file system.
- Cloud Sync: Seamlessly sync notes with your preferred cloud storage (Dropbox, Google Drive, etc.).
- Developer-Focused Features:
- Syntax highlighting for embedded code snippets.
- Customizable themes, including dark mode.
- Organization with tags and folder structure.
- Offline Support: Full functionality offline, with sync deferred until back online.
- Flutter: For cross-platform app development.
- Flutter SDK installed (Get Started with Flutter).
- A compatible code editor (e.g., VSCode or Android Studio).
- Clone the repository:
git clone https://github.com/abianche/nebula.git
- Navigate to the project directory:
cd nebula - Get dependencies:
flutter pub get
- Run the app:
flutter run
We are actively building the foundation of this project, and it is not yet ready for production use.
- 🔧 Features are incomplete and may change frequently.
- ❗ Breaking changes can occur as we iterate.
- 🐛 Bugs and unexpected behavior should be expected.
- 📚 Any documentation found in this repository may be outdated.
Here are some key milestones:
- Core markdown editor and local file storage.
- Implement live markdown preview and syntax highlighting.
- Add folder structure and tagging support.
- Cloud sync integration (Dropbox, Google Drive).
- Introduce customizable themes and advanced settings.
We appreciate your patience as we work toward our first stable release.
Stay tuned for updates and feel free to follow our progress or submit ideas in the Issues section.
Please read our Contributing Guidelines before getting started.
This project is licensed under the Apache License Version 2.0 - see the LICENSE file for details.
For questions or feedback, please reach out to [abianche@protonmail.com] or open an issue on the repository.
Happy coding with Nebula! 🌌