{"id":22883326,"url":"https://github.com/nocpiun/ferrum","last_synced_at":"2025-05-07T05:50:57.498Z","repository":{"id":41037516,"uuid":"473509853","full_name":"nocpiun/ferrum","owner":"nocpiun","description":"🌏 Explore throughout your server","archived":false,"fork":false,"pushed_at":"2024-10-27T08:11:54.000Z","size":38383,"stargazers_count":8,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T21:50:23.458Z","etag":null,"topics":["file-explorer","file-manager","nextjs","react","typescript","web-based"],"latest_commit_sha":null,"homepage":"https://ferrum-demo.nin.red","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nocpiun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"custom":["https://nocp.space/donate"]}},"created_at":"2022-03-24T08:02:38.000Z","updated_at":"2024-12-27T03:50:31.000Z","dependencies_parsed_at":"2024-08-11T05:14:51.196Z","dependency_job_id":"2d4ce9ac-e80f-4b20-8a78-bf38253d4202","html_url":"https://github.com/nocpiun/ferrum","commit_stats":null,"previous_names":["nriothrreion/ferrum"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nocpiun%2Fferrum","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nocpiun%2Fferrum/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nocpiun%2Fferrum/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nocpiun%2Fferrum/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nocpiun","download_url":"https://codeload.github.com/nocpiun/ferrum/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823693,"owners_count":21809709,"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":["file-explorer","file-manager","nextjs","react","typescript","web-based"],"created_at":"2024-12-13T18:35:23.400Z","updated_at":"2025-05-07T05:50:57.468Z","avatar_url":"https://github.com/nocpiun.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"./public/icon.png\" style=\"width:82px;\"/\u003e\n\n# Ferrum Explorer\n\n[![Author](https://img.shields.io/badge/Author-NriotHrreion-red.svg \"Author\")](https://github.com/NriotHrreion)\n[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg \"LICENSE\")](./LICENSE)\n[![Stars](https://img.shields.io/github/stars/nocpiun/ferrum.svg?label=Stars)](https://github.com/nocpiun/ferrum/stargazers)\n[![test](https://img.shields.io/github/actions/workflow/status/nocpiun/ferrum/ci.yml)](https://github.com/nocpiun/ferrum/actions/workflows/ci.yml)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/4bbf93a7-63d0-4512-bb3a-09345632ad1e/deploy-status)](https://app.netlify.com/sites/inspiring-torte-1d7e94/deploys)\n\n\u003e Explore throughout your server\n\n\u003c/div\u003e\n\n## Description\n\nFerrum Explorer is a web-based file explorer app for servers.\n\nBecause it's only maintained by me, so it might have some problems and bugs. You can raise an issue or create a pull request to tell me or fix it.\n\n#### Why its name is Ferrum?\n\n```\nFile Explorer -\u003e FE -\u003e Fe (Chemical Element) -\u003e Ferrum\n```\n\n#### May I have a look?\n\n**[Demo Site](https://ferrum-demo.nocp.space)** (Default password is `123456`)\n\n## Deploy \u0026 Use\n\nFirst, you need to make sure that your server (or computer) has installed Nodejs.\n\n1. **Download and install**\n\n```bash\ngit clone https://github.com/nocpiun/ferrum.git\ncd ferrum\nnpm i\nnpm run patch\nnpm run build\n```\n\n2. **Prepare the `.pwd` file**\n\nRename the `.pwd.example` to `.pwd` in the project root folder. This file stores your access key to Ferrum. The default password is `123456`, and you can change your password in the settings.\n\n```txt\nPASSWORD=....\n```\n\n3. **Run the app** (Recommended to use Administrator privilege)\n\n```bash\nnpm run start\n```\n\n4. **Enter `http://localhost:3300`**\n\n### To get update\n\nDo the following commands, then do `npm run start`.\n\n```bash\ngit fetch origin main:temp\ngit merge temp\nnpm i\n```\n\n### Something to notice\n\nFerrum Explorer requires ports `3300` to launch. If you see it reports `address already in use :::xxxx`, you should have a check to whether you've launched Ferrum Explorer and whether other apps are using the ports. And see the following steps.\n\n**Windows**\n\n```bash\nnetstat -aon | findstr [[here write the port it reported]]\ntaskkill /f /pid [[here write the PID the above command returned]]\n```\n\n**Linux \u0026 Mac OS**\n\n```bash\nlsof -i:[[here write the port it reported]]\nkill -9 [[here write the PID the above command returned]]\n```\n\n## Contributing\n\nContributions to Ferrum Explorer are welcomed. You can fork this project and start your contributing. If you don't know how to do, please follow the instruction [Creating a Pull Request from a Fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).\n\nI'll check the Pull Request list in my spare time. I can't make sure that every Pull Request will be seen by me at once.\n\n## Scripts\n\nAn explanation of the `package.json` scripts.\n\n- **`start`** Launch the app in production mode\n- **`dev`** Launch the app in development mode\n- **`patch`** Install `next-ws` plugin\n- **`build`** Create a production build\n- **`build:ci`** Create a production build for CI environment\n- **`lint`** Run ESLint\n\n## LICENSE\n\n[MIT](./LICENSE)\n","funding_links":["https://nocp.space/donate"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnocpiun%2Fferrum","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnocpiun%2Fferrum","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnocpiun%2Fferrum/lists"}