https://github.com/anav5704/note-app-electron
A native desktop notes app with markdown editing
https://github.com/anav5704/note-app-electron
electron reactjs tailwindcss
Last synced: 3 months ago
JSON representation
A native desktop notes app with markdown editing
- Host: GitHub
- URL: https://github.com/anav5704/note-app-electron
- Owner: anav5704
- Created: 2024-01-24T21:05:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T06:07:27.000Z (over 2 years ago)
- Last Synced: 2025-01-04T15:38:31.473Z (over 1 year ago)
- Topics: electron, reactjs, tailwindcss
- Language: TypeScript
- Homepage:
- Size: 1.12 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ShockPad - A Native Note App ⚡
This is a simple, native desktop note app for Windows. This app features markdown shortcuts and periodical auto saving. All the notes are saved as markdown files in the users file system in ```C:/Users//notes```. Deleting files also permanently removed the file from disk.
## Technologies Used
- Electron JS
- React JS
- TailwindCSS
- Jotai
## Getting Started
First, fork and clone the repo, and install all the required dependencies by running ```npm install```. You can view the app on localhost by running ```npm run dev```. Alternatively, you can run ``` npm run build:win``` to build it and the ShockPad installer can be found in ```dist/ShockPad-1.0.0-setup.exe```. Running this will install the app onto your machine.
## Learning Resources
- [Build a notes app with Electron](https://www.youtube.com/watch?v=t8ane4BDyC8)
- [Electron JS docs](https://www.electronjs.org/docs/latest)
- [React JS docs](https://legacy.reactjs.org/docs/getting-started.html)