Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jonas-is-coding/purenotes

Desktop App For Quick And Simple Markdown Notes
https://github.com/jonas-is-coding/purenotes

electron macos react

Last synced: about 17 hours ago
JSON representation

Desktop App For Quick And Simple Markdown Notes

Awesome Lists containing this project

README

        

# 📝 PureNotes

## Simple, Elegant, and Powerful Note-Taking App

PureNotes is a minimalist note-taking app focused on simplicity and efficiency. With a clear user interface and powerful features, PureNotes provides everything you need to create, manage, and organize your notes.

## Features

- 🌟 **Easy Creation and Management of Notes**
- 🚀 **Fast and Intuitive User Interface**
- 🎨 **Markdown Support**
- 🔍 **Content-Based Search (coming soon)**
- 🌈 **Benutzerdefinierte Themes und Anpassungen (coming soon)**
- ☁️ **Cloud Synchronization (coming soon)**

## Installation

### Requirements

- Node.js
- npm

### Installation Steps

1. **Clone the Repository**

```bash
git clone https://github.com/jonas-is-coding/purenotes.git
cd purenotes
```

2. **Install Dependencies**

```bash
npm i
```

3. **Keyboard Shortcuts**

```bash
npm run dev
```

## Tastenkombinationen

- **Create New Note**: `CommandOrControl+N`
- **Save**: `CommandOrControl+S`
- **Search**: `CommandOrControl+F`

## Architecture

PureNotes is built on [Electron](https://www.electronjs.org/), which allows the creation of cross-platform desktop apps using web technologies. The code is written in TypeScript and utilizes modern web technologies and frameworks.

## Folder Structure

```
PureNotes/
├── resources/ # Resources such as icons and logos
├── src/
│ ├── main/ # Main process code
│ ├── renderer/ # Renderer process code
│ ├── preload/ # Preload scripts
│ └── lib/ # Business logic and helper functions
├── package.json # npm configuration file
└── README.md # This file
```

## Contributing

We welcome contributions! Please read our [CONTRIBUTING.md](https://github.com/jonas-is-coding/purenotes/blob/main/contributing.md) for more information on how to contribute.

## License

This project is licensed under the MIT License. See the [LICENSE](https://github.com/jonas-is-coding/purenotes/blob/main/license.md) file for more information.

## Contact

- **Github**: [jonas-is-coding](https://github.com/jonas-is-coding)
- **Email**: [email protected]