Skip to content
/ Nota Public

AI-powered open source note-taking and todo list desktop application

License

Notifications You must be signed in to change notification settings

mtchdev/Nota

Repository files navigation

Nota Logo CLIENT-Test-DEV API-Test-DEV Size License

An open-source smart, optimized, and modern note-taking desktop application designed with Electron, Angular, and Flask. With the option of having your own Nota account, you can synchronize your notes wherever you are.

Trello (track our progress!): https://trello.com/b/FCZa1QZr/nota

Setup

⚠️ Nota is in a very early development stage. We're still designing!

Prerequisites

  • Node 8.0+
  • Git
  • Docker

Installation

$ git clone https://github.com/spliitzx/Nota && cd Nota

Once you have cloned Nota, run the following commands:

Client (Desktop Application):

cd nota
npm install

Server (API):

cd api
make server.install
make database.upgrade
make server.start

You will need to rename .env.example to .env and edit the values to your liking.

Running

Unless you're building from source, you want to run the application in a development environment. To do so, you will need to compile Electron & Angular together, through the following command (in the /nota subdirectory):

npm run start:dev

Or, likewise in a production environment:

npm run start:prod

To run the API, you will need Docker. To view the setup, look at the README file in /api