https://github.com/dylanlott/storj-express
https://github.com/dylanlott/storj-express
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dylanlott/storj-express
- Owner: dylanlott
- Created: 2017-08-16T14:03:06.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-12T19:29:34.000Z (over 8 years ago)
- Last Synced: 2025-02-14T16:05:26.449Z (over 1 year ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
storj-express
=============
add a storj server to an existing express app quickly and easily
`npm install github:dylanlott/storj-express --save`
```js
const express = require('express');
const app = express();
const storj = require('storj-express');
app.use('/storj', storj({
bridgeUrl: 'https://api.storj.io',
bridgeUser: ,
bridgePass: ,
encryptionKey: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about',
logLevel: 4
}));
app.listen(1337, () => {
console.log('storj-enabled express server now running on port 1337');
});
```
you can `app.use()` this route anywhere to namespace a storj service endpoint wherever you want.
or, alternatively, you can use this to setup a storj microservice by namespacing it to the root url `/`
however you want to use this is up to you! let your imagination run wild.
## Roadmap
This is a work in progress middleware package.
The following routes still need to be implemented
- [x] .getInfo(function(err, result) {}) - Gets general API info`
- [x] .getBuckets(function(err, result) {}) - Gets list of available buckets
- [x] .createBucket(bucketName, function(err, result) {}) - Creates a bucket
- [x] .deleteBucket(bucketId, function(err, result) {}) - Deletes a bucket
- [x] .listFiles(bucketId, function(err, result) {}) - List files in a bucket
- [x] .storeFile(bucketId, filePath, options) - Uploads a file, returns state object
- [ ] .storeFileCancel(state) - This will cancel an upload
- [ ] .resolveFile(bucketId, fileId, filePath, options) - Downloads a file, return state object
- [ ] .resolveFileCancel(state) - This will cancel a download
- [x] .deleteFile(bucketId, fileId, function(err, result) {}) - Deletes a file from a bucket
- [x] .destroy() - This will zero and free memory of encryption keys and the environment