Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maurocamerini/desktop-react-sql-ledger
Portable desktop app to track income and expenses. Built with Electron, React, and SQLite.
https://github.com/maurocamerini/desktop-react-sql-ledger
crud electron react sqlite webpack
Last synced: 3 days ago
JSON representation
Portable desktop app to track income and expenses. Built with Electron, React, and SQLite.
- Host: GitHub
- URL: https://github.com/maurocamerini/desktop-react-sql-ledger
- Owner: MauroCamerini
- License: mit
- Created: 2024-12-26T04:59:50.000Z (13 days ago)
- Default Branch: master
- Last Pushed: 2025-01-04T15:30:23.000Z (4 days ago)
- Last Synced: 2025-01-04T16:27:00.991Z (4 days ago)
- Topics: crud, electron, react, sqlite, webpack
- Language: JavaScript
- Homepage:
- Size: 152 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Desktop React SQL Ledger
Desktop React SQL Ledger is a portable desktop app to track income and expenses. Built with **Electron**, **React**, and **SQLite**.
*[Versión en español](/docs/es/readme.md)*
## Features
- **Transaction Management**: Add, view, and manage financial transactions with ease.
- **Local Storage**: Utilizes a SQLite database for fast, reliable local data storage.
- **Cross-Platform**: Built with Electron to run seamlessly on Windows, macOS, and Linux.
- **User-Friendly UI:** Built with React, featuring React Router, Forms, and Bootstrap for a clean, smooth experience.
## Main Tech Stack
- **Electron**: Bridges web technologies with native desktop capabilities, making it possible to run this app as a standalone application on multiple operating systems. [:link:](https://nodejs.org/)
- **Better SQLite3**: Powers the app's database operations stored in a file. [:link:](https://nodejs.org/)
- **React**: Builds the user interface in the Render Process. [:link:](https://react.dev/)
*[See full tech stack here](/docs/techstack.md)*
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/en/download/package-manager "Node.js") and [npm](https://www.npmjs.com/ "npm") installed on your machine.
### Installation
1. Clone this repository:
```bash
git clone https://github.com/MauroCamerini/desktop-react-sql-ledger.git
```
2. Navigate to the project directory:
```bash
cd desktop-react-sql-ledger
```
3. Install dependencies:
```bash
npm install
```
4. Start the application:
```bash
npm start
```
### Documentation
- [Architecture Details](/docs/architecture.md)
- [Full tech stack](/docs/techstack.md)
- [Frequently Asked Questions](/docs/faq.md)
- [Project Setup](/docs/projectsetup.md)
### Current Status
The application enables users to add new entries through a validated form, view existing entries with filtering and pagination functionality, edit entries. These features—forms, filtering, pagination, and data loading—are implemented using *template* components, making it relatively easy to add new features (e.g., editing another table). Key upcoming features include delete and update functionalities, exporting/importing to Excel, and dynamically generated queries for generating reports.
## License
This project is licensed under the MIT License. See the LICENSE file for details.