inspektor/README.md

85 lines
2.6 KiB
Markdown
Raw Permalink Normal View History

2017-12-17 16:02:08 +00:00
# RS Inspektor
2017-12-17 16:02:08 +00:00
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.
2023-09-20 20:41:57 +00:00
You're invited to contribute to this app and/or submit feedback to improve it. Please use the
[RS Discourse forums](https://community.remotestorage.io/t/rs-inspektor-a-simple-remotestorage-file-browser/428)
to post issues or ideas, and/or to request an account for gitea.kosmos.org
if you want to submit pull requests directly to the upstream repository. You
may also submit Git patches via [e-mail](mailto:raucao@kip.pe).
## Features
* [x] Connect RS accounts
* [x] Traverse/inspect directories
* [x] View document details
* [x] Render images in details
2018-03-04 15:09:48 +00:00
* [x] Render text content in details
* [x] Render JSON content tree view (optional source view)
2018-01-04 19:30:27 +00:00
* [x] Delete documents
2018-06-19 16:35:43 +00:00
* [x] Edit JSON content in tree view
2021-02-25 18:52:16 +00:00
* [x] Delete directories
2018-03-04 15:09:48 +00:00
* [ ] Edit content source
2023-09-20 20:41:57 +00:00
* [ ] Render other types of content (e.g. audio and video)
* [ ] Copy/move documents
* [ ] Copy/move directories (and enclosed files)
* [ ] Loading indicator for any view change that loads remote data
* [ ] Logo/icon
2018-03-04 15:15:07 +00:00
* [ ] Layout/support for small screens
## 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
2017-12-17 16:02:08 +00:00
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/)