Skip to content

lotfijb/bullet-journal-extension

Repository files navigation

Bullet Journal

Note taking extension to jot down quick thoughts or to save longer notes

Features

This is a list of features to be added soon to this extension.

  • Light/dark mode feature following browser's settings
  • Adding note category
  • Regrouping notes by category
  • Adding note priority
  • Adding images to notes

Installation

Clone the repository to your machine using :

git clone https://github.com/lotfijb/bullet-journal-extension

Change directory to where you cloned the repository

cd bullet-journal-extension

Install required dependepncies

npm install or npm i

Start the project in localhost (Project built with Vite JS)

npm run dev or npm start

Usage

Building the extension is needed

To do so, run the command :

npm run build

After building the dist folder, head to this link that will guide you How to install the unpacked extension in your browser.

Contributing

Please read CONTRIBUTING.md

Please make sure to check the Features to add section.

Code of Conduct

Please read Code of Conduct

Author

Contributors