Skip to content

Commit

Permalink
docs: update readme with project overview
Browse files Browse the repository at this point in the history
  • Loading branch information
Mersho committed Oct 21, 2024
1 parent 5c068a1 commit a9ac6b1
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
![screenshot_light](https://github.com/user-attachments/assets/6f6c5e58-83d6-4b77-9c8a-806a7be302d2)
![screenshot](https://github.com/user-attachments/assets/0c3b697e-7763-4e4e-9fad-32692714cada)

## Project overview

FileBox is a cross-platform web-based file explorer

## Features

- [ ] Monitor current directory for real-time changes
- [ ] Show/hide hidden files (any file or folder that starts with a dot character)
- [ ] Upload, download, remove, create capabilities
- [ ] Right-click and context menu
- [ ] Other ways of viewing files (such as list view)
- [ ] SortBy
- [ ] GroupBy
- [ ] Remote download
- [ ] File sharing

## Development

- Clone the repository:
```
git clone https://github.com/Mersho/FileBox.git
```
- Navigate to the project directory:
```
cd FileBox
```
- Install frontend dependencies:
```
cd FileBox
npm install
```
- Build the frontend:
```
npm run build
```
- Install Go dependencies:
```
cd ..
go mod tidy
```
- Run:
```
go run main.go
```
- Build:
```
go build
```

0 comments on commit a9ac6b1

Please sign in to comment.