{"id":26985462,"url":"https://github.com/dhaoloth/code-explorer","last_synced_at":"2025-04-03T18:23:45.867Z","repository":{"id":285268654,"uuid":"957562755","full_name":"dhaoloth/code-explorer","owner":"dhaoloth","description":"Local Code Explorer: Desktop application built with Electron for browsing local directories, visualizing code structure, viewing files with syntax highlighting, basic editing, and exporting project summaries (MD, XML, TXT).","archived":false,"fork":false,"pushed_at":"2025-04-02T18:53:10.000Z","size":264,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T19:38:51.946Z","etag":null,"topics":["code-documentation","code-explorer","desktop-app","developer-tools","electron","file-viewer","local-development","markdown-export","repository-viewer"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dhaoloth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-30T17:11:33.000Z","updated_at":"2025-04-02T18:53:14.000Z","dependencies_parsed_at":"2025-03-30T18:36:58.788Z","dependency_job_id":null,"html_url":"https://github.com/dhaoloth/code-explorer","commit_stats":null,"previous_names":["dhaoloth/rce_lite","dhaoloth/code-explorer"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhaoloth%2Fcode-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhaoloth%2Fcode-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhaoloth%2Fcode-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhaoloth%2Fcode-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dhaoloth","download_url":"https://codeload.github.com/dhaoloth/code-explorer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247053752,"owners_count":20875903,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-documentation","code-explorer","desktop-app","developer-tools","electron","file-viewer","local-development","markdown-export","repository-viewer"],"created_at":"2025-04-03T18:23:45.397Z","updated_at":"2025-04-03T18:23:45.847Z","avatar_url":"https://github.com/dhaoloth.png","language":"JavaScript","readme":"# Code Explorer\n\nCode Explorer is a desktop application built with Electron for browsing local directory structures, viewing and editing files, and exporting project contents in various formats. It aims to provide a simple interface for quickly understanding and documenting local codebases.\n\n## Features\n\n*   **Directory Structure Viewer**: Interactive tree-style display of files and folders for local projects.\n*   **File Content Viewing**: View text-based files within the application.\n*   **Syntax Highlighting**: Supports highlighting for numerous programming languages using Highlight.js.\n*   **Basic File Editing**: Edit text files directly within the app (enable by double-clicking a file). Save changes with `Ctrl+S` or the \"Save\" button, discard with `Esc`.\n*   **Multi-Format Project Export**: Export the structure and content of the loaded local project (filtered by extension and ignoring specified items like `node_modules`, binaries, etc.) as:\n    *   Markdown (`.md`)\n    *   XML (`.xml`)\n    *   Text File Structure (`.txt`)\n*   **Folder History**: Quickly access the last 5 opened local folders via a dropdown menu initiated by the \"History\" button. Includes an option to clear the history.\n*   **Git Repository Finder**: Scan a selected parent directory to find local `.git` repositories within it.\n*   **GitHub Loading (Placeholder)**: The \"Open GitHub\" button currently serves as a placeholder, indicating that direct loading from GitHub URLs is planned for future updates.\n*   **User-Friendly**: Minimalist interface with key keyboard shortcuts (`Ctrl+O` for Open Local, `Ctrl+E` for Export, `Ctrl+S` for Save).\n\n## Installation\n\n### Build from Source (Recommended for Developers)\n\n1.  Ensure you have Node.js (v18+) and npm installed.\n2.  **(Optional but Recommended for Windows Build):** Install Windows build tools:\n    ```bash\n    npm install --global --production windows-build-tools\n    # or install Visual Studio Build Tools manually\n    ```\n3.  Clone the repository:\n    ```bash\n    git clone https://github.com/dhaoloth/code-explorer.git\n    ```\n4.  Navigate to the project directory:\n    ```bash\n    cd code-explorer\n    ```\n5.  Install dependencies:\n    ```bash\n    npm install\n    ```\n6.  Run the application locally:\n    ```bash\n    npm start\n    ```\n\n### Prebuilt Release\n\nYou can download ready-to-use Windows versions (if provided) from the [Releases](https://github.com/dhaoloth/code-explorer/releases) section of this repository.\n\n## Usage\n\n1.  **Open Local Folder**: Click \"Open Local\" or use `Ctrl+O`. Select a local project folder.\n2.  **Open GitHub**: Clicking \"Open GitHub\" currently shows a placeholder message; direct loading is planned for future updates.\n3.  **Browse Files**: Click a file in the tree to view its contents.\n4.  **Edit File**: **Double-click** a file in the tree to enable editing mode.\n    *   Save changes with `Ctrl+S` or the \"Save\" button.\n    *   Discard changes and exit editing mode by pressing `Esc`.\n5.  **Export Project**: Click \"Export\" (`Ctrl+E`), choose a save location and format (`.md`, `.xml`, `.txt`). This works for the currently loaded local project.\n6.  **History**: Click the \"History\" button to see and open recent local folders. Use \"Clear History\" within the dropdown to reset it.\n7.  **Scan Home**: Click \"Scan Home\", select a parent directory, and the file tree will be replaced with a list of found local Git repositories. Click a result to open it.\n\n## Build Instructions (Windows 10+ x64)\n\nAfter following the \"Build from Source\" steps (including installing dependencies):\n\n*   **Build for 64-bit Windows (NSIS Installer):**\n    ```bash\n    npm run build\n    ```\n\nThe installer (`Code-Explorer-Setup-1.1.3-x64.exe`) will be located in the `dist` directory.\n\n## Technologies\n\n*   **Electron**: For cross-platform desktop application development.\n*   **Highlight.js**: For syntax highlighting.\n*   **Font Awesome**: For interface icons.\n*   **electron-store**: For persistent history storage.\n\n## License\n\nThis project is licensed under the MIT License.\n\n---\n\nFor questions or suggestions, please open an [Issue](https://github.com/dhaoloth/code-explorer/issues) or contact me.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhaoloth%2Fcode-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdhaoloth%2Fcode-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhaoloth%2Fcode-explorer/lists"}