Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/akash2061/notebook-app


https://github.com/akash2061/notebook-app

application desktop-app electron-app electronjs notebook-app productivity-tool project utility-application

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

![Banner](./.github-assets/Notebook-app.gif)
![Version](https://img.shields.io/github/v/release/akash2061/NoteBook-app)
![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20Windows-blueviolet)
![GitHub all releases](https://img.shields.io/github/downloads/akash2061/NoteBook-app/total?&color=gold)
[![License](https://img.shields.io/github/license/ladunjexa/reactjs18-3d-portfolio?color=dddddd)](https://github.com/akash2061/NoteBook-app/blob/main/LICENSE)
![Maintenance](https://img.shields.io/badge/maintenance-actively--maintained-brightgreen)
![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/akash2061/NoteBook-app/NoteBook_1.1.0_amd64.deb?label=.deb&color=azure)
![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/akash2061/NoteBook-app/NoteBook_1.1.0_amd64.snap?label=.snap&color=azure)
![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/akash2061/NoteBook-app/NoteBook-1.0.0.pacman?label=.pacman&color=azure)
![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/akash2061/NoteBook-app/notebook-1.0.0-setup.exe?label=.exe&color=azure)

# 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.

![Demo](.github-assets/Demo4.png)

## 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](https://github.com/akash2061/NoteBook-app/releases).

### For [Debian Based](https://github.com/akash2061/NoteBook-app/releases/tag/v1.1.0):
+ [Setup (.deb)](https://github.com/akash2061/NoteBook-app/releases/download/v1.1.0/NoteBook_1.1.0_amd64.deb)
+ [Setup (.snap)](https://github.com/akash2061/NoteBook-app/releases/download/v1.1.0/NoteBook_1.1.0_amd64.snap)
### For [Arch Linux](https://github.com/akash2061/NoteBook-app/releases/tag/v1.0.0-Linux):
+ [Setup (.pacman)](https://github.com/akash2061/NoteBook-app/releases/download/v1.0.0-Linux/NoteBook-1.0.0.pacman)
#### Note: Navigate to downloads folder & run:
#### For .pacman:
```bash
sudo pacman -U NoteBook_.pacman
```
#### For .deb:
```bash
sudo dpkg -i NoteBook__amd64.deb
```
#### For .snap:
```bash
sudo snap install --dangerous NoteBook__amd64.snap
```
### For [Windows](https://github.com/akash2061/NoteBook-app/releases/tag/v1.0.0):
+ [Setup](https://github.com/akash2061/NoteBook-app/releases/download/v1.0.0/notebook-1.0.0-setup.exe)
+ [Pre-installed]()

## Project Setup:

### Clone Repo. or Download [.ZIP](https://github.com/akash2061/NoteBook-app/archive/refs/heads/master.zip)

```bash
$ git clone https://github.com/akash2061/NoteBook.git
```
### Install
```bash
$ npm install
```

### Development

```bash
$ 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](LICENSE). By using this application, you agree to the terms and conditions outlined in the license agreement.