README.md

Notebook: A Desktop Application.

Notebook is a powerful Electron application built with React and TypeScript, designed to streamline your note-taking experience. With its intuitive interface and robust features, Notebook provides a seamless platform for organizing your thoughts, ideas, and tasks.

Getting Started

• Installation: Begin by installing Notebook using the provided installation instructions.

• Create a Note: Launch Notebook and start creating your first note by clicking on the New Note button.

• Organize: Use tags and categories to organize your notes for easy retrieval.

• Start Writing: Dive into the world of note-taking with Notebook and unleash your creativity.

• Note Storage: Notes are stored in ~/NoteBook/ folder in makedown .md format.

Successfully Tested on:

• Kali Linux - 2024.2 (Linux-6.8.11-amd64)
• Arch Linux - x86_64 (6.9.5-arch1-1)
• Ubuntu - 24.04 LTS
• Windows 11

Download NoteBook:

Releases Page.

For Debian Based:

• Setup (.deb)
• Setup (.snap)

For Arch Linux:

• Setup (.pacman)

Note: Navigate to downloads folder & run:

For .pacman:

sudo pacman -U NoteBook_<version>.pacman 

For .deb:

sudo dpkg -i NoteBook_<version>_amd64.deb 

For .snap:

sudo snap install --dangerous NoteBook_<version>_amd64.snap

For Windows:

• Setup
• Pre-installed

Project Setup:

Clone Repo. or Download .ZIP

$ git clone https://github.com/akash2061/NoteBook.git

Install

$ npm install

Development

$ npm run dev

Contributing

I encourage contributions from the community to help make Notebook even better. Whether it's bug fixes, feature enhancements, or documentation improvements, every contribution is valuable.

License

Notebook is released under the MIT License. By using this application, you agree to the terms and conditions outlined in the license agreement.