jaipradeesh / steam-web-interface

[ARCHIVED] Web interface for sTeam server

sTeam-web-interface

Web interface for sTeam - https://github.com/eMBee/sTeam/tree/steam-2.9-source

Setup Instructions

• Install npm

dnf install npm

• Install dependencies and start the server

npm install && npm start

Contributing

Development board

Trello board

Commits

• Give proper commit messages that describe the change.
• Each commit message should be granular, solving a specific issue.
• Don't mangle a lot of commits together, unless asked for.
• Use GFM in commit messages to link to issues if they are related.
• Use a short summary on the first line.
• Use Markdown in commit messages to make them more readable.
• Wrap commit message lines at 80 chars.

Pull requests

• Ensure that you have worked on the latest code to avoid re-introducing removed diffs.
• Give a proper title to your pull requests.
• Giving a description will make the aliens smile.
• Giving a description is no excuse to commit messages that make aliens sad.

steam-web-interface's Issues

Implement `loading` button

Generate workarea view

Wireframe

Decode the URIs

to avoid %252F instead of /

Write tests for API

Requests to test

• me object
• /home
• /home/dolftax
• If inventory.class == "Room" then inventory.documents should exist
• If inventory.icon.mime_type == */gif then inventory.icon.name should end with .gif | regex - /.(.*)$/

Integrate breadcrumb with the states

As we handle deeply nested objects in single state with path as stateParams , don't use angular-breadcrumb module. It labels each child state and displays in the breadcrumb.

Generate detailed view

Wireframe

Generate list view

Wireframe

Generate Create room and Create document view

Wireframes

Handle workspace clicks

When an item is clicked on the workspace, the handler should

1. get the path as parameter
2. get the type ( room || document || container )

If document

- get the mimetype as parameter
- show the resp editor/viewer

if ((inventory.class == Document) && (inventory.mime_type == x) // x can be application/pdf , image/jpg, ..
    load x viewer/editor

If room

if ((inventory.class == Room) && (inventory.documents != 0 )
    goto inventory.path // open list view

If Container

Show "container can't be traversed into"

3. update the location in URL
4. update the level in breadcrumb

Tab handling

• Contents of /home/dolftax in Private tab
• Contents of /home in Groups tab

Ex:
Private tab would have all the contents (rooms, docs, etc.. which are private to the user) of hostname/scripts/rest.pike?request=/home/dolftax

Groups tab would have all the contents of hostname/scripts/rest.pike?request=/home

Note: The contents are handled as referred in #10

Integrate the document viewer with listing

The document viewer supports all mime types now. Have to link them to the listing and make the flow work.

`items not defined` on reloading home

Because of error with order of loading filter (or) data not passed between scopes

Save option in WYSIWYG editor

onClick of save, POST the changes to the document.

createDoc() and createRoom() modals are not Responding.

Note : This is a minor fix since only the Cancel button is not working.

Tracker issue for document handler

The views/detailed.html file would have all the editor/viewer of the resp. document type and controllers/detailedCtrl.js handles and loads the respective editor/viewer

add mp3 support for audio

Use ngAudio

Implement 'drag rooms/documents to move'

Ref - https://github.com/bevacqua/dragula/blob/master/readme.markdown

Fix the login and implement logout

Local storage module is breaking.

Update: Local storage module is fixed.

Implement `delete` option

and bind it with delete option.

Create routes to handle views

Routes

State 1 - If not logged in, whichever URL,

• /login - workarea ( login view)

State 2 - If logged in

• /home || / - workarea ( list view ) [shared workarea]
• /:username - workarea ( list view ) [private workarea]
• /:username/:room-name - workarea ( list view )
• /:username/:document-name - workarea ( detailed view )
• /:username/:container-name - workarea ( error view )
• /:username/:room-name/:sub-room-name - workarea ( list view )
• /:username/:room-name/:document-name - workarea ( detailed view )
• /xyz - workarea ( error view )

PS: Handle the options in the breadcrumb accordingly.

onClick of Object doesn't work as expected

The path parameter is polluted with random characters and doesn't navigate to the respective view.

Modify the code to follow standard style

https://github.com/feross/standard

• Module import
• Change the code style

Make the UI responsive

The top bar has a lot of columns and options. Figure out a way to make the column responsive (mobile-friendly).

Gulp things.

Tasks to do

• Run tests / Integration with travis
• Minify the code
• Cleanup unused dir/files in bower_components

.. work in progress

Controllers executing twice

Generate login view

Wireframe

Implement controller for create room/document modals

Bind the API calls with the resp views

• Create room
• Create document - api-needed

Improve navigation

Add right sidebar for better navigation.

Configure server to work with html5 mode

As we use $locationProvider.html5Mode(true) (to remove hashes in the URL), it requires server side rewrites to work.

Ref - https://github.com/angular-ui/ui-router/wiki/Frequently-Asked-Questions#how-to-configure-your-server-to-work-with-html5mode

Implement Search and Sort

Add search and support for the items in current scope

• Search
• Sort

Configure otherwise/unknown routes to login

Server should handle this. Angular can't. Because, hashbang.

Integrate comments

Room listing (a group of rooms) specific && document-specific comments

Move from bower to CDN

Reason: bower is bloating too much.

Generate Shared Workarea view template

Wireframe

move from root scope to local storage for data persistence

root scope works when the flow id followed. but on refresh, it breaks. So, changing the code to use localstorage instead of root scope, thus achieving data persistence.

Fix the download option

For unknown content type, the user should be able to download the file locally as it can't be viewed in the browser window.