79 lines
2.2 KiB
Markdown
79 lines
2.2 KiB
Markdown
# RS Inspektor
|
|
|
|
Inspektor is a simple file browser for inspecting the contents of a
|
|
[remoteStorage](https://remotestorage.io) account. It is intended for RS app
|
|
developers and power users.
|
|
|
|
Inspektor is beta software and currently under development. You're invited to
|
|
contribute and/or give feedback: https://gitlab.com/skddc/inspektor
|
|
|
|
## Features
|
|
|
|
* [x] Connect RS accounts
|
|
* [x] Traverse/inspect directories
|
|
* [x] View document details
|
|
* [x] Render images in details
|
|
* [x] Render text content in details (e.g. JSON)
|
|
* [x] Delete documents
|
|
* [ ] Delete directories
|
|
* [ ] Render other types content (e.g. audio and video)
|
|
* [ ] Edit text content (and save changes)
|
|
* [ ] Copy/move documents
|
|
* [ ] Copy/move directories (and enclosed files)
|
|
* [ ] Loading indicator for any view change that loads remote data
|
|
* [ ] Logo/icon
|
|
|
|
## Prerequisites
|
|
|
|
You will need the following things properly installed on your computer.
|
|
|
|
* [Git](https://git-scm.com/)
|
|
* [Node.js](https://nodejs.org/) (with NPM)
|
|
* [Ember CLI](https://ember-cli.com/)
|
|
* [Google Chrome](https://google.com/chrome/)
|
|
|
|
## Installation
|
|
|
|
* `git clone <repository-url>` this repository
|
|
* `cd inspektor`
|
|
* `npm install`
|
|
|
|
## Running / Development
|
|
|
|
* `ember serve`
|
|
* Visit your app at [http://localhost:4200](http://localhost:4200).
|
|
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
|
|
|
|
### Code Generators
|
|
|
|
Make use of the many generators for code, try `ember help generate` for more details
|
|
|
|
### Running Tests
|
|
|
|
* `ember test`
|
|
* `ember test --server`
|
|
|
|
### Building
|
|
|
|
* `ember build` (development)
|
|
* `ember build --environment production` (production)
|
|
|
|
### Deploying
|
|
|
|
With the 5apps remote added correctly (and push access to the GitLab repo),
|
|
just run:
|
|
|
|
npm run deploy
|
|
|
|
If you want to deploy this from and to different repos, have a look at the
|
|
`scripts` section in `package.json`, as well as `scripts/deploy.sh` for how it
|
|
works.
|
|
|
|
## Further Reading / Useful Links
|
|
|
|
* [ember.js](https://emberjs.com/)
|
|
* [ember-cli](https://ember-cli.com/)
|
|
* Development Browser Extensions
|
|
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
|
|
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
|