Update dependencies, README
This commit is contained in:
38
README.md
38
README.md
@@ -2,18 +2,48 @@
|
||||
|
||||
[](https://travis-ci.org/chrisvrose/nodejs-fm)
|
||||
|
||||
A simple file manager for managing files on a remote fs using Node.
|
||||
A simple file manager for managing files on a remote fs using Node.
|
||||
|
||||
Dependencies: `express` `body-parser` `sqlite`
|
||||
Dependencies: `express` `body-parser` `@fortawesome/fontawesome-free` `chai` `mocha` `chai-http` `jquery` `requests` `sqlite3`
|
||||
|
||||
Checklist:
|
||||
## Checklist
|
||||
|
||||
- [x] Folder Traversal
|
||||
- [ ] Filesystem viewing
|
||||
- [ ] Upload
|
||||
- [ ] Auth
|
||||
|
||||
Credit:
|
||||
## Usage
|
||||
|
||||
Use `settings.json` and point it to a valid address, and select a required port. Default `8080`
|
||||
|
||||
For the backend, the jsons have this form
|
||||
|
||||
Requests:
|
||||
|
||||
```json
|
||||
{
|
||||
loc: "<valid location>"
|
||||
}
|
||||
```
|
||||
Responses (Only for directory traversals):
|
||||
|
||||
```json
|
||||
{
|
||||
loc: "<location>",
|
||||
back: "<location>|null",
|
||||
contents:[
|
||||
{
|
||||
name:"<filename>",
|
||||
path:"<location>",
|
||||
isDir: "<true|false>"
|
||||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Credit
|
||||
|
||||
- Samuel Thornton: [Material Design Box Shadows]("https://codepen.io/sdthornton/pen/wBZdXq")
|
||||
- StackOverflow: Troubleshooting errors
|
||||
|
Reference in New Issue
Block a user