https://github.com/nocpiun/ferrum
🌏 Explore throughout your server
https://github.com/nocpiun/ferrum
file-explorer file-manager nextjs react typescript web-based
Last synced: 6 months ago
JSON representation
🌏 Explore throughout your server
- Host: GitHub
- URL: https://github.com/nocpiun/ferrum
- Owner: nocpiun
- License: mit
- Created: 2022-03-24T08:02:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T08:11:54.000Z (12 months ago)
- Last Synced: 2025-04-14T21:50:23.458Z (6 months ago)
- Topics: file-explorer, file-manager, nextjs, react, typescript, web-based
- Language: TypeScript
- Homepage: https://ferrum-demo.nin.red
- Size: 36.6 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Ferrum Explorer
[](https://github.com/NriotHrreion)
[](./LICENSE)
[](https://github.com/nocpiun/ferrum/stargazers)
[](https://github.com/nocpiun/ferrum/actions/workflows/ci.yml)
[](https://app.netlify.com/sites/inspiring-torte-1d7e94/deploys)
> Explore throughout your server
## Description
Ferrum Explorer is a web-based file explorer app for servers.
Because 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.
#### Why its name is Ferrum?
```
File Explorer -> FE -> Fe (Chemical Element) -> Ferrum
```
#### May I have a look?
**[Demo Site](https://ferrum-demo.nocp.space)** (Default password is `123456`)
## Deploy & Use
First, you need to make sure that your server (or computer) has installed Nodejs.
1. **Download and install**
```bash
git clone https://github.com/nocpiun/ferrum.git
cd ferrum
npm i
npm run patch
npm run build
```
2. **Prepare the `.pwd` file**
Rename 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.
```txt
PASSWORD=....
```
3. **Run the app** (Recommended to use Administrator privilege)
```bash
npm run start
```
4. **Enter `http://localhost:3300`**
### To get update
Do the following commands, then do `npm run start`.
```bash
git fetch origin main:temp
git merge temp
npm i
```
### Something to notice
Ferrum 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.
**Windows**
```bash
netstat -aon | findstr [[here write the port it reported]]
taskkill /f /pid [[here write the PID the above command returned]]
```
**Linux & Mac OS**
```bash
lsof -i:[[here write the port it reported]]
kill -9 [[here write the PID the above command returned]]
```
## Contributing
Contributions 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).
I'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.
## Scripts
An explanation of the `package.json` scripts.
- **`start`** Launch the app in production mode
- **`dev`** Launch the app in development mode
- **`patch`** Install `next-ws` plugin
- **`build`** Create a production build
- **`build:ci`** Create a production build for CI environment
- **`lint`** Run ESLint
## LICENSE
[MIT](./LICENSE)