https://github.com/husseinhareb/elenotes

Simple app for taking notes using Electron
https://github.com/husseinhareb/elenotes

electron electronjs nedb note-taking notes-app

Last synced: about 14 hours ago
JSON representation

Simple app for taking notes using Electron

• Host: GitHub
• URL: https://github.com/husseinhareb/elenotes
• Owner: husseinhareb
• License: mit
• Created: 2023-11-16T11:15:05.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-09T13:08:50.000Z (12 months ago)
• Last Synced: 2023-12-10T13:36:51.223Z (12 months ago)
• Topics: electron, electronjs, nedb, note-taking, notes-app
• Language: JavaScript
• Homepage:
• Size: 42 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Elenotes

## Description

A simple note-taking application built with [Electron](https://www.electronjs.org/) and NeDB, providing a user-friendly GUI to manage notes effectively.

## Features

- **Note Creation**: Click the "Add" icon and start typing your note.

- ![addNotes](https://github.com/husseinhareb/Elenotes/assets/88323940/523b36f4-c41d-47c1-9149-aaff7da8f4be)

- **Editing Notes**: Click the "Edit" icon and start editing your previous note.

- ![edit-note](https://github.com/husseinhareb/Elenotes/assets/88323940/af6d7213-bf36-4d78-9130-2938ad18db45)

- **Deleting Notes**: Click the delete icon next to the note.

- ![ezgif com-resize](https://github.com/husseinhareb/Elenotes/assets/88323940/08344844-1707-44eb-98e9-fbc2a3f29f10)

- **Delete All Notes**: Use the "Delete All" icon to clear all notes.

- ![deleteAll-note](https://github.com/husseinhareb/Elenotes/assets/88323940/ef367a2f-80b4-427d-943a-c70bafed7fda)

## Languages Used

- Electron(Html,Css,Javascript)

- [nedb](https://github.com/louischatriot/nedb)

## Installation

### Executable Release

1. Go to the [Releases]([https://github.com/your-username/note-taking-app/releases](https://github.com/husseinhareb/Elenotes/releases/tag/Electron)) section of this repository.

2. Download the latest release package for your operating system.

3. Extract the downloaded package to a location of your choice.

4. Run the executable file (`Elenotes.exe` for Windows, `Elenotes` for Linux).

### Getting Started

Follow these steps to run the app locally:

1. **Clone the repository**:

    ```bash

    git clone https://github.com/husseinhareb/Elenotes

    ```

2. **Install dependencies**:

    ```bash

    cd Elenotes/src

    npm install electron --save-dev

    ```

3. **Run the application**:

    ```bash

    npm start

    ```

## Contributing

Contributions are welcome! If you'd like to contribute:

    Fork the repository.

    Create your branch: git checkout -b feature/YourFeature.

    Commit your changes: git commit -m 'Add some feature'.

    Push to the branch: git push origin feature/YourFeature.

    Submit a pull request.

## License

This project is licensed under the [MIT License](https://github.com/husseinhareb/Elenotes/blob/main/LICENSE).