{"id":13509663,"url":"https://github.com/matthew-matvei/freeman","last_synced_at":"2025-03-30T13:32:42.369Z","repository":{"id":176188498,"uuid":"110365915","full_name":"matthew-matvei/freeman","owner":"matthew-matvei","description":"A free, extensible, cross-platform file manager for power users","archived":true,"fork":false,"pushed_at":"2020-10-01T01:24:58.000Z","size":2247,"stargazers_count":291,"open_issues_count":8,"forks_count":39,"subscribers_count":20,"default_branch":"develop","last_synced_at":"2024-11-01T09:35:06.624Z","etag":null,"topics":["electron","filemanager","minimalist","pty","typescript","xterm"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matthew-matvei.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-11-11T17:36:42.000Z","updated_at":"2024-07-02T19:49:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"af3b37f9-bf9f-4aeb-97a8-d4974d6ca740","html_url":"https://github.com/matthew-matvei/freeman","commit_stats":null,"previous_names":["matthew-matvei/freeman"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthew-matvei%2Ffreeman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthew-matvei%2Ffreeman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthew-matvei%2Ffreeman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matthew-matvei%2Ffreeman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matthew-matvei","download_url":"https://codeload.github.com/matthew-matvei/freeman/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246324272,"owners_count":20759104,"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":["electron","filemanager","minimalist","pty","typescript","xterm"],"created_at":"2024-08-01T02:01:11.125Z","updated_at":"2025-03-30T13:32:41.973Z","avatar_url":"https://github.com/matthew-matvei.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","electron","Apps","typescript"],"sub_categories":["Open Source"],"readme":"# FreeMAN\n\n[![Travis-CI build status](https://travis-ci.org/matthew-matvei/freeman.svg?branch=develop)](https://travis-ci.org/matthew-matvei/freeman)\n[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/a919pf573a0tv0fg/branch/develop?svg=true)](https://ci.appveyor.com/project/matthew-matvei/freeman)\n[![Dependencies](https://david-dm.org/matthew-matvei/freeman.svg)](https://david-dm.org/matthew-matvei/freeman)\n[![Dev Dependencies](https://david-dm.org/matthew-matvei/freeman/dev-status.svg)](https://david-dm.org/matthew-matvei/freeman#info=devDependencies)\n[![Maintainability](https://api.codeclimate.com/v1/badges/962d19a24fb074a1df39/maintainability)](https://codeclimate.com/github/matthew-matvei/freeman/maintainability)\n[![First contributions welcome](http://img.shields.io/badge/first--contributions-welcome-green.svg?style=flat-square)](.github/CONTRIBUTING.md)\n\nA free, extensible, cross-platform file manager for power users\n\n---\n\n![FreeMAN with open integrated terminal](./resources/using-the-app.gif)\n\n## Features\n\n* Quick, clean, dual-paned file-system navigation with a strong keyboard-led\n    focus\n* Integrated terminal per navigation pane for those things a file explorer just\n    can't do\n* Focus on customisability to tailor it to the user's whims\n* Quick navigation with a *Go To* box\n\n### Future\n\n* Tighter integration between navigation and integrated terminals\n* Further behaviour to be customisable\n* Extending usefulness of the *Go To* and *Commands* boxes\n\n## Roadmap\n\n* Core application ready for beta use\n* Out-of-the-box plugins ready for beta use\n* Core application ready for production use\n* Out-of-the-box plugins ready for production use\n\nThe core application is ready for beta use, supporting Linux and Windows OS's. Feel free to set up\n`electron-builder` for MacOS and make a PR.\n\n## Getting started\n\n    npm install\n    npm start\n\nIf you want, you can add user-specific settings files, e.g. `freeman.keys.json`\nlike so:\n\n    touch {userData}/freeman.keys.json\n\n`{userData}` above refers to Electron's `app.getPath(\"userData\")` location, *(which\ndepends on whether the application is running in a development or production\nenvironment)*. Example files can be found in the `./resources/` folder.\n\n## Packaging\n\nIf you would like to package / install the program, on Windows and Linux you can:\n\n    npm run package\n\nThen run the appropriate built executable.\n\n## Running\n\nDuring development, after compiling you can:\n\n    npm run start\n\nAfter packaging, you can run the system-dependent executable outputted by\n`electron-builder` in the `./dist/` folder.\n\n## Developing\n\nAn overview of the codebase can be found in the [docs](docs/CODE_STRUCTURE.md).\nIf you find it helpful, you can `npm run docs` and open the generated\n`docs/generated/index.html` file. Please let me know if you find this useful.\n\n## Debugging\n\nProviding the `--verbose` or `-V` command-line argument will make the application\nlog in more detail, helping trace execution when using the packaged app. Logs of\nwarnings and errors can be found at `{appData}/log.log`.\n\n## How to contribute\n\nContributions are welcome! Work on the core application is still under way. There are\nnumerous areas with room for improvement in usability and stability. My\npriorities for development are currently:\n\n* Core functionality\n* Plugin functionality (starting with out-of-the-box ones)\n* Appearance\n\nI'll take whatever pull requests, issues, contributors and PMs I can get! Please\nhave a look at the [Contributing Guidelines](./.github/CONTRIBUTING.md) before\nsubmitting a PR.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthew-matvei%2Ffreeman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatthew-matvei%2Ffreeman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatthew-matvei%2Ffreeman/lists"}