https://github.com/lotfijb/bullet-journal-extension
Note taking browser extension
https://github.com/lotfijb/bullet-journal-extension
extension extension-chrome javascript reactjs
Last synced: 5 months ago
JSON representation
Note taking browser extension
- Host: GitHub
- URL: https://github.com/lotfijb/bullet-journal-extension
- Owner: lotfijb
- License: mit
- Created: 2022-11-06T21:35:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T15:47:24.000Z (almost 3 years ago)
- Last Synced: 2025-04-01T03:41:33.205Z (7 months ago)
- Topics: extension, extension-chrome, javascript, reactjs
- Language: JavaScript
- Homepage: https://addons.mozilla.org/en-US/firefox/addon/bullet-journal/
- Size: 128 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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 :
```bash
git clone https://github.com/lotfijb/bullet-journal-extension
```
Change directory to where you cloned the repository
```bash
cd bullet-journal-extension
```
Install required dependepncies
```bash
npm install or npm i
```
Start the project in localhost
(Project built with Vite JS)
```bash
npm run dev or npm start
```
## Usage
Building the extension is needed
To do so, run the command :
```bash
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](https://webkul.com/blog/how-to-install-the-unpacked-extension-in-chrome/).
* Google chrome, Microsoft Edge, Opera and Opera GX are supported for now using build method.
* For Firefox users, [click here to download Bullet Journal from Mozilla Add-Ons](https://addons.mozilla.org/en-US/firefox/addon/bullet-journal/)
* Download [dist folder here](https://drive.google.com/drive/folders/1bb5hCfqUlUV-sptiTSRD-0OkL40HaxaT?usp=sharing) and [upload it manually](https://webkul.com/blog/how-to-install-the-unpacked-extension-in-chrome/).
## Contributing
Please read [CONTRIBUTING.md](https://github.com/lotfijb/bullet-journal-extension/blob/main/CONTRIBUTING.md)
Please make sure to check the [Features to add](#Features) section.
## Code of Conduct
Please read [Code of Conduct](https://github.com/lotfijb/bullet-journal-extension/blob/main/CODE_OF_CONDUCT.md)
## Author
* [Lotfi Jebali](https://github.com/lotfijb)
## Contributors
* [Adrián Marín](https://github.com/adrianmarinwork)