Skip to content

Commit 1d9ba38

Browse files
authored
Merge pull request #60 from 5apps/docs/improve_readme
Update README
2 parents ab1b833 + 404cc82 commit 1d9ba38

File tree

2 files changed

+27
-12
lines changed

2 files changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
1-
# storage-frontend
1+
[![Build Status](https://drone.5apps.com/api/badges/5apps/stashboard/status.svg)](https://drone.5apps.com/5apps/stashboard)
22

3-
A dashboard for managing one's remoteStorage authorizations.
3+
# Stashboard
4+
5+
Stashboard is a dashboard application for managing one's
6+
[remoteStorage](https://remotestorage.io/) account. It has been created by
7+
5apps as the front-end for [5apps Storage](https://5apps.com/storage).
8+
9+
![Screenshot of a 5apps Storage dashboard](screenshots/connected-apps.png)
10+
11+
## Storage providers & developers
12+
13+
Feel free to use this for your own server implementation, and also to just
14+
re-use parts of the code (e.g. markup and styles).
15+
16+
If you are genuinely interested in adopting this front-end for your server
17+
implementation, we would also be willing to help with making the app more
18+
customizable, so that you wouldn't have to run a custom fork per se. The GitHub
19+
issues are open for any and all requests.
20+
21+
## Users
22+
23+
For security reasons, it is not currently possible to log into your 5apps
24+
account when the app is not opened from `rs.5apps.com`. This may change in the
25+
future.
426

527
## Prerequisites
628

@@ -13,13 +35,13 @@ You will need the following things properly installed on your computer.
1335

1436
## Installation
1537

16-
* `git clone git@github.com:5apps/storage-frontend.git` this repository
17-
* `cd storage-frontend`
38+
* `git clone git@github.com:5apps/stashboard.git` this repository
39+
* `cd stashboard`
1840
* `npm install`
1941

2042
## Running / Development
2143

22-
* `ember serve`
44+
* `npm start`
2345
* Visit your app at [http://localhost:4200](http://localhost:4200).
2446
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
2547

@@ -37,10 +59,3 @@ You will need the following things properly installed on your computer.
3759
### Deploying
3860

3961
* `npm run deploy:staging` or `npm run deploy:production`
40-
41-
## FIXME Re-add Sentry support
42-
43-
To create new Sentry releases and upload sourcemaps during deploy,
44-
you'll need to copy the `.env.example` file as `.env` and add your token
45-
to it. The token can be created at https://sentry.io/api/ with the scope
46-
"project:releases".

screenshots/connected-apps.png

152 KB
Loading

0 commit comments

Comments
 (0)