GitHub - Acreom/app: 2nd brain for software engineers. A local-first knowledge base for your daily context and projects.

2 min read Original article ↗

Netlify Status Test Release

acreom logo

2nd brain for software engineers. Fast, simple and private.

If you're looking for a well-designed local-first open-source markdown knowledge base on steroids, you found it. acreom can be used as your daily notebook for your stand-up notes or your daily agenda, personal issue tracker, project organizer or as a knowledge base. It's designed for speed, simplicity and privacy.

Features

  • Pages & Tasks
  • Projects & Views
  • Vaults
  • E2EE Sync Across Multiple Devices
  • Page Version History
  • Page & Folder Sharing (PRO)
  • Jira Sync (PRO)
  • GitHub Sync (PRO)
  • Linear Sync (PRO)
  • Apple Calendar Sync
  • Google Calendar Sync (PRO)
  • .ics Calendar Sync
  • acreom Assistant (with ChatGPT Custom Token)

Support

acreom's server costs are funded by our awesome community of PRO supporters 💙 If you'd like to support acreom please consider subscribing: https://acreom.com/pricing

Development Quick Start

Prerequisites

  • Node.js version >=18.16
  • yarn version >=1.22

Installation

  1. Fork the repository and clone it to your local machine

    After forking, run the following command to clone the repository to your local machine:

    git clone git@github.com/your-username/acreom.git

  2. Install the dependencies

    Navigate to the project directories (quick capture, frontend, and electron) and install the required dependencies:

    cd acreom
cd frontend
yarn install
cd ..
cd electron
yarn install
cd ..
cd quick-capture
yarn install

Steps

Start Quick Capture, frontend, then run electron

The order in which you run the commands is important. Electron binds to the port that is used by the frontend, so you need to start the frontend first. Quick Capture doesn't need to be started at all, you can skip the step entirely.

cd quick-capture
yarn dev

Contributing

We welcome any contributions to acreom. You can learn how to contribute by reading our contributing guidelines.

License

This project is licensed under the GNU GPLv3 License - see the LICENSE file for details.