Skip to content

A collaborative, scriptable note taking application.

License

Notifications You must be signed in to change notification settings

chrisdedman/cursif

 
 

Repository files navigation

Cursif

Cursif is yet another note-taking application that adds an exciting twist to your productivity. Unlike conventional tools, Cursif empowers you with scriptable notes, allowing you to craft personalized macros for streamlined note automation.

Introduction

Cursif redefines the note-taking experience by allowing users to harness the power of scripting to automate repetitive tasks and create custom workflows. Whether you're a developer, student, or business professional, Cursif empowers you to take control of your notes like never before.

Features

  • Scriptable notes for automating tasks
  • Easy-to-use interface for creating and managing notes
  • Cross-platform compatibility (officially supports Linux)
  • Secure and private note storage
  • And much more!

How to Install

⚠️ Cursif officially supports Linux only. Although it should work on Windows and MacOS, it could have unexpected behavior or errors.

Docker (Recommended)

  1. Install Docker and Docker Compose.
  2. Clone the repository and update the submodule:
    git clone https://.../cursif.git
    git submodule update --init --recursive
  3. Create a .env file in the root directory and copy the contents of .env.example into it.
  4. Run docker-compose up.
  5. Access the backend at http://localhost:4000 and the frontend at http://localhost:3000.

Manual Installation

  1. Install PostgreSQL.
  2. Follow the installation instructions for the frontend and backend.

Configuration

Before running Cursif, please make sure that you configure any necessary environment variables and settings.

  • Create a new file named .env in the root directory.
  • Copy the content of .env.example into your .env

Usage

Once installed, start exploring Cursif's features by visiting the http://localhost:3000 and if needed the http://localhost:4000 in your browser. You can try the app by creating a new account or using the dev user with the following credentials:

Email   : dev@example.com
Pasword : Password1234

Contributing

We welcome contributions from the community! If you'd like to contribute to Cursif, please review our contributing guidelines for more information.

License

Cursif is licensed under the GPL 3.0 license. By using this software, you agree to comply with the terms and conditions of this license.


Feel free to join our Discord server to connect with other users and contributors!

About

A collaborative, scriptable note taking application.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published