https://github.com/kelvink96/todo-electron-react-app
A todo desktop application built using Electron, React(Vite), Better-Sqlite3 and Ant Design.
https://github.com/kelvink96/todo-electron-react-app
Last synced: 3 months ago
JSON representation
A todo desktop application built using Electron, React(Vite), Better-Sqlite3 and Ant Design.
- Host: GitHub
- URL: https://github.com/kelvink96/todo-electron-react-app
- Owner: kelvink96
- Created: 2024-02-22T11:03:18.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-22T11:46:26.000Z (over 1 year ago)
- Last Synced: 2025-01-22T13:39:17.717Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 259 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# todo-electron-react-app
A todo desktop application built using Electron, React(Vite), Better-Sqlite3 and Ant Design.
## Recommended IDE Setup
- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## Project Setup
### Install
```bash
$ pnpm install
```
### Development
```bash
$ pnpm dev
```
### Build
```bash
# For windows
$ pnpm build:win
# For macOS
$ pnpm build:mac
# For Linux
$ pnpm build:linux
```
## Project File Structure
- models
- dbManager.ts - contains all db initializer configs
- taskManager.ts - contains all SQL CRUD queries and statements for interacting with the tasks table
- interfaces - contains declared types/interfaces
- src
- preload - has the written window api configurations serving as a middleware connecting database executions and exposing these functions to the client side in the renderer function
- renderer - contains all the client side pages, routes (and respective configs), and components