Beaver Pocket

Build your knowledge one log at a time

Developed with love ❤️ in 🇪🇺

Website | Blog | Docs | Downloads | Mastodon | Reddit | Bluesky

Beaver Pocket is a privacy-focused note-taking app built for Android and iOS. Your notes are securely stored on your device, ensuring complete privacy and control over your data.

Important

Beaver Pocket is still in the release candidate stage. While bugs are far less common than in alpha or beta versions, it's still good practice to back up your data and report any issues. Thank you!

🎯 Goals

• Privacy-Respecting: All your data is stored on your device.
• User-Friendly: A simple and intuitive interface makes note-taking a delightful experience.
• Tags: Organize notes by using tags to group related content.
• Note Linking: Create a web of interconnected ideas and notes.
• Locked Notes: Keep your thoughts and ideas private, ensuring only you can access them.
• Sync Your Notes: Sync your notes across devices using the sync provider you trust most.
• Community-Driven: Made for the community, by the community.
• Discover more on our website.

💻 Looking for a desktop version?

Beaver Pocket isn’t just for mobile; it also has a desktop version called Beaver Notes!

Setting up your machine to run Beaver Notes Pocket

Prerequisites:

• Node.js 18 or higher
• Yarn
• Visual Studio Code (VSCode) with the Ionic plugin
• Xcode (for iOS development) and/or Android Studio (for Android development)

Installation Steps:

Clone the Repository:

Start by cloning the Beaver Notes Pocket repository to your local machine. You can do this using Git by running the following command in your terminal:

git clone https://github.com/your-repo-url.git

Install Dependencies:

Navigate to the cloned repository directory using your terminal and install the project's dependencies using Yarn. Run the following commands:

cd beaver-notes-pocket
yarn install

Open in VSCode:

Open the project folder in Visual Studio Code (VSCode). Ensure you have the Ionic plugin installed to work with Ionic projects effectively.

iOS and Android Setup (Optional):

If you intend to develop for both iOS and Android, make sure you have Xcode (for iOS) and/or Android Studio (for Android) installed. Set up the necessary emulators or connect physical devices for testing.

Run the App:

To run Beaver Notes Pocket on your local development server, use the following command:

ionic serve

This will launch the app in your default web browser for development.

Platform-Specific Builds (Optional):

If you want to build the app for iOS or Android specifically, you can use Ionic's commands for that purpose. For example, to build an iOS app, run:

ionic build ios

And for Android:

ionic build android

These commands will generate platform-specific build files in the respective platform directories.