search

vaisakhsasikumar / my-electron-app

A desktop application built with Electron that allows users to run a given MongoDB find queries and view the results in JSON format.
Apache License 2.0
0 stars 3 forks source link

readme

Nightly Build

System Name

Simple Electron MongoDB Query Tool

Description

A desktop application built with Electron that allows users to run a given MongoDB find queries and view the results in JSON format.

Contributors

Use cases for the Simple Electron MongoDB Query Tool:

  1. Running MongoDB Queries: Users can input and execute MongoDB find queries, enabling them to retrieve specific data from the MongoDB database.

  2. Viewing Results in JSON Format: After executing a query, users can view the results in a structured JSON format, making it easy to read and understand the data returned.

  3. Configuring MongoDB Connection: The application utilizes the MongoDB URI, Database, and Collection specified in the settings while running queries. This approach allows users to easily configure their connection details without needing to input connection strings each time they execute a query.

  4. Overviewing Execution History: Users can invoke an "Advanced View" feature to see a simplified history of their queries and replies.

  5. Persisting Query History: Users can have their previous queries saved in local storage, allowing them to easily access and rerun past queries without retyping.

  6. Managing Settings and Theme: The application includes a settings menu that allows users to switch themes and MongoDB URI/Database/Collection. Settings are persisted in local storage in order to facilitate users not to enter them each time after the app has been restarted. Settings have default values, which are used when the app starts for the first time, and lately can be replaced anytime.

External System(s)

MongoDB: The primary database system used for managing and querying data. MongoDB facilitates the storage of JSON-like documents with dynamic schemas, which is integral to the query tool's operation. MongoDB Documentation

SQLite: Local database for local storage

System Architecture Style

The Simple Electron MongoDB Query Tool employs a Monolithic Architecture Style, combining both frontend and backend functionalities within a single application. This approach simplifies development and deployment, enabling users to execute MongoDB queries directly from the Electron interface without requiring a separate server.

Architecture Diagram

Screenshot

Repository and Branching Strategy

This project is hosted on GitHub, with source code managed and integrated with a CI/CD pipeline for automated build and testing. We have mono github repo for the whole project. We create PRs and merge them to master branch from our personal repos or our branches from current repo.

Deployment Model

The Simple Electron MongoDB Query Tool can be deployed as a native desktop application across various operating systems, including Windows, macOS, and Linux. Leveraging ElectronJS capabilities, the app can package web technologies into standalone executables, allowing users to easily install and run the application on their local machines without needing an additional server setup. This ensures a seamless experience for users while maintaining consistent functionality across platforms.

Project Board

Board

Proof-of-Concept Desktop Application using Electron

Screenshot

Technologies

Purpose

To provide hands-on experience with:

Steps to Run the Application

  1. Install dependencies:

    
npm install

  2. Build, Run and Deploy:

    
npx webpack
npm start

Test Cases

Click here to view the Test Cases