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

Nightly Build

System Name

Simple Electron MongoDB Query Tool

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. Fixed MongoDB Connection: The application allows access to a predefined or stored in settings MongoDB connection, simplifying the setup process for the user since they don't need to input connection strings.

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

  5. Settings and Theme Management: The application includes a settings menu that allows users to switch themes and MongoDB URI/Database/Collection.

  6. Comparison of Query Results: Users can invoke an "Advanced View" feature to see a simplified history of their queries and replies.

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

Branching Strategy

TBD

Deployment Model

TBD

Proof-of-Concept Desktop Application using Electron

Screenshot

Description

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

Technologies

Features

Purpose

To provide hands-on experience with:

Repository

This project is hosted on GitHub, with source code managed and integrated with a CI/CD pipeline for automated build and testing.


Steps to Run the Application

  1. Install dependencies:
    
    npm install
  2. Run Node Server:
    
    node backend/server.js
  3. Build and Deploy:
    
    npx webpack
    npx electron .

Test Cases

Click here to view the Test Cases