Skip to content

ScribbleLabApp/ScribbleLab

Header

ScribbleLab for iOS, macOS and visionOS

ScribbleLab is a revolutionary text editor designed exclusively for students, delivering a seamless experience across iOS, macOS and visionOS platforms. Created by students, for students, it offers a lightweight yet powerful editor with a visually appealing design and a user-friendly interface.

Note

ScribbleLab is currently in development and not yet ready for production use. You are welcome to test the latest alpha/dev build at your own risk. We welcome feedback here.

Warning

ScribbleLab is not working as expected on iOS 17.4 beta. Please use Xcode 15.2 and iOS 17.3.1. Our developers are currently investigating this issue.

Translations

This README is available in different languages: English · Deutsch · Italiano · 日本語 (まだ利用できません)

Motivation

We at ScribbleLab found that the existing text editors on the market were too complicated, lacked essential features, or were difficult to customize for our specific needs.

We thought, "Why isn't there an app that has everything you need?"

That's why we decided to create our own text editor, with complete control over its functionality and features.

Mission

Our mission at ScribbleLab is to create an app that makes everyday life easier for students.

Students often need to use multiple apps to organize their academic lives. With the workflows of students in mind, we combine four existing apps (Reminder, Calendar, Timetable, and Clock) into two apps with a visually appealing design and a seamlessly integrated editor: ScribbleLab and ScribbleLink

We strive to remain true to Apple's human interface guidelines and design patterns, ensuring ScribbleLab looks and feels like an application developed by Apple themselves, with meticulous attention to detail.

Features

Our editor is the "Scribble" part of ScribbleLab, and our features comprise the "Lab".

ScribbleLab offers a comprehensive suite of tools, including:

  • Live collaborations (coming soon)
  • Linked cloud storage (Dropbox, GoogleDrive, iCloudDrive, etc.)
  • Customizable templates (pages, covers, etc.)
  • Import/export PDFs, PNGs, and .scribble files (own file format, coming soon)
  • AI support (coming soon)
  • Integration with ScribbleLink

Features are easily accessible from a sidebar, providing a powerful yet user-friendly experience. Our feature selection is driven by community and tester feedback, ensuring relevance and usefulness to students.

Many of our features are available from a sidebar where they can be accessed by a simple click.

Community

To decide what features to include, we invite and assess feedback from our community and testers, ensuring that our feature list is relevant and useful to students.

Our community comprises contributors from GitHub, testers, developers, and users. Join our Discord server for improved communication among community members.

Privacy

Is it safe to create an account with ScribbleLab? Yes!

We at ScribbleLab believe that privacy is a fundamental right and should be treated with utmost importance. When it comes to personal data, it is important that it is stored securely and responsibly. It is crucial that individuals have control over their data. You should be able to access, manage, and delete your data easily and privately. This is especially important in the context of data breaches, where personal information can fall into the wrong hands.

Therefore, we store your data on your device or on your third-party cloud storage accounts only, ensuring that the data is not accessible to unauthorized individuals or entities. We use Google Firebase (which includes FirebaseAuth, FirebaseStorage, and Cloud Firestore) to securely store your data. This means that no one can access your personal data, such as created documents or cloud services, not even us. The only thing we can see is how many people have a ScribbleLab account, along with data from Google Analytics and Google Crashlytics to track crashes and other unusual events or bugs.

Ensuring the security of our software is a top priority for us. We regularly release software updates that include bug fixes and security patches to keep your data and system secure. It is important to install these updates as soon as they become available to ensure that you are protected from the latest threats.

To make the process of updating your software easier, we have implemented an automatic update feature that will prompt you to install new updates as soon as they become available. We highly recommend that you enable this feature so that you always have the latest security updates installed.

In addition to automatic updates, we also provide manual update instructions for macOS on our website. Please make sure to follow these instructions carefully to ensure a smooth update process.

Remember, staying up to date with software updates is an essential part of maintaining the security and integrity of your system.

Caution

No warranty is provided for testing Alpha, Beta, nightly, or RC builds. Use at your own risk.

Contributing

Be part of the next revolution in code editing by contributing to the project. This is a community-led effort, so we welcome as many contributors who can help. Read the Contribution Guide for more information.

This project spans multiple repositories so instead of browsing issues in the issues tab, it may be helpful to find an issue to get started on in our project board.

For issues we want to focus on that are most relevant at any given time, please see the issues scoped to our current iteration here.

License

When you create a ScribbleLab account, you are agreeing to our License Agreement as well as the licenses of our third-party packages.

This open-source project has been licensed under two separate licenses. The Apache 2.0 License applies to the entirety of the project, while the AGPL 3.0 License applies specifically to ScribbleLab's Auth code and service. The Apache 2.0 License is a permissive license that allows for the distribution of the software under certain terms and conditions. On the other hand, the AGPL 3.0 License is a copyleft license that requires any modifications or derivatives of the code to be released under the same license. It is important to note that the licenses are not interchangeable, and adherence to both is necessary for proper use and distribution of the project.

ScribbleLab's main LICENSE · ScribbleLab's Auth LICENSE

Trademarks

In order to use ScribbleLabApp's trademarks as logos or copy content you'll need to agree to our Trademark Guidelines.

Support Us

Your support is valuable to us and helps us dedicate more time to enhancing and maintaining this repository. Here's how you can contribute:

⭐️ Leave a Star: If you find this repository useful or interesting, please consider leaving a star on GitHub. Your stars help us gain visibility and encourage others in the community to discover and benefit from this work.

✨ Follow us on YouTube:If you find this repository useful or interesting, please consider leaving a sub on YouTube. Your sub help us gain visibility and encourage others in the community to discover and benefit from this work.

📲 Share with Friends: If you like the idea behind this project, please share it with your friends, colleagues, or anyone who might find it valuable.