-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update readme with project overview
- Loading branch information
Showing
1 changed file
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
 | ||
 | ||
|
||
## 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 | ||
``` |