Skip to content

Commit d3a6ac4

Browse files
Update version number to 1.1.0, remove SVG logo and replace it with PNG, clean up import instructions and adjust authorisation descriptions in the configuration file.
1 parent 1e08fa7 commit d3a6ac4

File tree

10 files changed

+48
-80
lines changed

10 files changed

+48
-80
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,79 @@
11
# 📝 PureNotes
22

3-
## Einfache, elegante und leistungsstarke Notizen-App
3+
## Simple, Elegant, and Powerful Note-Taking App
44

5-
PureNotes ist eine minimalistische Notiz-App, die sich auf Einfachheit und Effizienz konzentriert. Mit einer klaren Benutzeroberfläche und leistungsstarken Funktionen bietet PureNotes alles, was du für das Erstellen, Verwalten und Organisieren deiner Notizen benötigst.
5+
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.
66

77
## Features
88

9-
- 🌟 **Einfaches Erstellen und Verwalten von Notizen**
10-
- 🚀 **Schnelle und intuitive Benutzeroberfläche**
11-
- 🎨 **Unterstützung für Markdown**
12-
- 🔍 **Inhaltsbasierte Suche**
13-
- 🌈 **Benutzerdefinierte Themes und Anpassungen**
14-
- ☁️ **Cloud-Synchronisation (bald verfügbar)**
9+
- 🌟 **Easy Creation and Management of Notes**
10+
- 🚀 **Fast and Intuitive User Interface**
11+
- 🎨 **Markdown Support**
12+
- 🔍 **Content-Based Search (coming soon)**
13+
- 🌈 **Benutzerdefinierte Themes und Anpassungen (coming soon)**
14+
- ☁️ **Cloud Synchronization (coming soon)**
1515

1616
## Installation
1717

18-
### Voraussetzungen
18+
### Requirements
1919

2020
- Node.js
2121
- npm
2222

23-
### Schritte zur Installation
23+
### Installation Steps
2424

25-
1. **Repository klonen**
25+
1. **Clone the Repository**
2626

2727
```bash
2828
git clone https://github.com/jonas-is-coding/purenotes.git
2929
cd purenotes
3030
```
3131

32-
2. **Abhängigkeiten installieren**
32+
2. **Install Dependencies**
3333

3434
```bash
35-
yarn
35+
npm i
3636
```
3737

38-
3. **App starten**
38+
3. **Keyboard Shortcuts**
3939

4040
```bash
41-
yarn dev
41+
npm run dev
4242
```
4343

4444
## Tastenkombinationen
4545

46-
- **Neue Notiz erstellen**: `CommandOrControl+N`
47-
- **Speichern**: `CommandOrControl+S`
48-
- **Suchen**: `CommandOrControl+F`
46+
- **Create New Note**: `CommandOrControl+N`
47+
- **Save**: `CommandOrControl+S`
48+
- **Search**: `CommandOrControl+F`
4949

50-
## Architektur
50+
## Architecture
5151

52-
PureNotes basiert auf [Electron](https://www.electronjs.org/), das es ermöglicht, plattformübergreifende Desktop-Apps mit Web-Technologien zu erstellen. Der Code ist in TypeScript geschrieben und verwendet moderne Web-Technologien und -Frameworks.
52+
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.
5353

54-
## Ordnerstruktur
54+
## Folder Structure
5555

5656
```
5757
PureNotes/
58-
├── resources/ # Ressourcen wie Icons und Logos
58+
├── resources/ # Resources such as icons and logos
5959
├── src/
60-
│ ├── main/ # Hauptprozess Code
61-
│ ├── renderer/ # Rendererprozess Code
62-
│ ├── preload/ # Preload Skripte
63-
│ └── lib/ # Geschäftslogik und Helferfunktionen
64-
├── package.json # npm Konfigurationsdatei
65-
└── README.md # Diese Datei
60+
│ ├── main/ # Main process code
61+
│ ├── renderer/ # Renderer process code
62+
│ ├── preload/ # Preload scripts
63+
│ └── lib/ # Business logic and helper functions
64+
├── package.json # npm configuration file
65+
└── README.md # This file
6666
```
6767

68-
## Mitwirken
68+
## Contributing
6969

70-
Wir freuen uns über Beiträge! Bitte lese unsere [CONTRIBUTING.md](https://github.com/jonas-is-coding/purenotes/blob/main/contributing.md) für weitere Informationen darüber, wie du beitragen kannst.
70+
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.
7171

72-
## Lizenz
72+
## License
7373

74-
Dieses Projekt steht unter der MIT Lizenz. Weitere Informationen findest du in der [LICENSE](https://github.com/jonas-is-coding/purenotes/blob/main/license.md) Datei.
74+
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.
7575

76-
## Kontakt
76+
## Contact
7777

7878
- **Github**: [jonas-is-coding](https://github.com/jonas-is-coding)
7979
- **Email**: jonasbrahmst@gmail.com

build/icon.ico

8.39 KB
Binary file not shown.

build/icon.png

11.3 KB
Loading

electron-builder.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ nsis:
2121
mac:
2222
entitlementsInherit: build/entitlements.mac.plist
2323
extendInfo:
24-
- NSCameraUsageDescription: Application requests access to the device's camera.
25-
- NSMicrophoneUsageDescription: Application requests access to the device's microphone.
26-
- NSDocumentsFolderUsageDescription: Application requests access to the user's Documents folder.
27-
- NSDownloadsFolderUsageDescription: Application requests access to the user's Downloads folder.
24+
- NSCameraUsageDescription: PureNotes requests access to the device's camera.
25+
- NSMicrophoneUsageDescription: PureNotes requests access to the device's microphone.
26+
- NSDocumentsFolderUsageDescription: PureNotes requests access to the user's Documents folder.
27+
- NSDownloadsFolderUsageDescription: PureNotes requests access to the user's Downloads folder.
2828
notarize: false
2929
dmg:
3030
artifactName: ${name}-${version}.${ext}

electron.vite.config.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,25 @@ export default defineConfig({
77
plugins: [externalizeDepsPlugin()],
88
resolve: {
99
alias: {
10-
"@/lib": resolve("src/main/lib"),
11-
"@shared": resolve("src/shared")
10+
'@/lib': resolve('src/main/lib'),
11+
'@shared': resolve('src/shared')
1212
}
1313
}
1414
},
1515
preload: {
1616
plugins: [externalizeDepsPlugin()]
1717
},
1818
renderer: {
19-
assetsInclude: "src/renderer/assets/**",
19+
assetsInclude: 'src/renderer/assets/**',
2020
resolve: {
2121
alias: {
2222
'@renderer': resolve('src/renderer/src'),
23-
"@shared": resolve("src/shared"),
24-
"@/hooks": resolve("src/renderer/src/hooks"),
25-
"@/assets": resolve("src/renderer/src/assets"),
26-
"@/data": resolve("src/renderer/src/data"),
27-
"@/components": resolve("src/renderer/src/components"),
28-
"@/mocks": resolve("src/renderer/src/mocks")
23+
'@shared': resolve('src/shared'),
24+
'@/hooks': resolve('src/renderer/src/hooks'),
25+
'@/assets': resolve('src/renderer/src/assets'),
26+
'@/data': resolve('src/renderer/src/data'),
27+
'@/components': resolve('src/renderer/src/components'),
28+
'@/mocks': resolve('src/renderer/src/mocks')
2929
}
3030
},
3131
plugins: [react()]

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "purenotes",
3-
"version": "1.0.0",
3+
"version": "1.1.0",
44
"description": "Eine einfache Notizen App, entwickelt von Jonas Brahmst.",
55
"main": "./out/main/index.js",
66
"author": "Jonas Brahmst",

resources/purenotes-logo.png

2.1 KB
Loading

resources/purenotes-logo.svg

Lines changed: 0 additions & 12 deletions
This file was deleted.

src/main/index.ts

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
import { electronApp, is, optimizer } from '@electron-toolkit/utils'
22
import { BrowserWindow, app, ipcMain, shell } from 'electron'
33
import { join } from 'path'
4-
import icon from '../../resources/purenotes-logo.svg?asset'
4+
import icon from '../../resources/purenotes-logo.png?asset'
55
import { createNote, deleteNote, getNotes, readNote, writeNote } from '@/lib'
66
import { CreateNote, DeleteNote, GetNotes, ReadNote, WriteNote } from '@shared/types'
77

88
function createWindow(): void {
9-
// Create the browser window.
109
const mainWindow = new BrowserWindow({
1110
width: 900,
1211
height: 670,
@@ -36,30 +35,20 @@ function createWindow(): void {
3635
return { action: 'deny' }
3736
})
3837

39-
// HMR for renderer base on electron-vite cli.
40-
// Load the remote URL for development or the local html file for production.
4138
if (is.dev && process.env['ELECTRON_RENDERER_URL']) {
4239
mainWindow.loadURL(process.env['ELECTRON_RENDERER_URL'])
4340
} else {
4441
mainWindow.loadFile(join(__dirname, '../renderer/index.html'))
4542
}
4643
}
4744

48-
// This method will be called when Electron has finished
49-
// initialization and is ready to create browser windows.
50-
// Some APIs can only be used after this event occurs.
5145
app.whenReady().then(() => {
52-
// Set app user model id for windows
5346
electronApp.setAppUserModelId('com.electron')
5447

55-
// Default open or close DevTools by F12 in development
56-
// and ignore CommandOrControl + R in production.
57-
// see https://github.com/alex8088/electron-toolkit/tree/master/packages/utils
5848
app.on('browser-window-created', (_, window) => {
5949
optimizer.watchWindowShortcuts(window)
6050
})
6151

62-
// IPC test
6352
ipcMain.handle('getNotes', (_, ...args: Parameters<GetNotes>) => getNotes(...args))
6453
ipcMain.handle('readNote', (_, ...args: Parameters<ReadNote>) => readNote(...args))
6554
ipcMain.handle('writeNote', (_, ...args: Parameters<WriteNote>) => writeNote(...args))
@@ -69,20 +58,12 @@ app.whenReady().then(() => {
6958
createWindow()
7059

7160
app.on('activate', function () {
72-
// On macOS it's common to re-create a window in the app when the
73-
// dock icon is clicked and there are no other windows open.
7461
if (BrowserWindow.getAllWindows().length === 0) createWindow()
7562
})
7663
})
7764

78-
// Quit when all windows are closed, except on macOS. There, it's common
79-
// for applications and their menu bar to stay active until the user quits
80-
// explicitly with Cmd + Q.
8165
app.on('window-all-closed', () => {
8266
if (process.platform !== 'darwin') {
8367
app.quit()
8468
}
8569
})
86-
87-
// In this file you can include the rest of your app"s specific main process
88-
// code. You can also put them in separate files and require them here.

src/renderer/src/main.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import React from 'react'
21
import { createRoot } from 'react-dom/client'
32
import { BrowserRouter as Router, Route, Routes } from 'react-router-dom'
43
import App from './App'

0 commit comments

Comments
 (0)