Skip to content

docs: add README.md file #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2018
Merged

docs: add README.md file #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# express-rest-file-server
![travis-ci](https://travis-ci.org/bitIO/express-rest-file-server.svg?branch=master)

An express based application, inspired by [mock-file-server](https://github.com/betajs/mock-file-server), to be used as a CRUD file server storing content in the memory (temporal) or in the disk (permanent) of the server.

## Usage
You can either install it globally o locally to your project

```shell
# global installation
npm install -g express-rest-file-server
# local installation
npm install express-rest-file-server
```

To start using it with default options, just run

```shell
# global installation
express-rest-file-server
# local installation
npx express-rest-file-server
```

### Options

* port: defaults to 5000
* storageType: can be `memory` or `disk` (defaults to memory)
* storagePath: where to store the files if storage is set to `disk` (defaults to `/tmp`)