Veavy'S Code

Veavy'S Code Extension for Visual Studio Code. This repository contains the visual studio code extension for weavy

Hackathon Presentation

Powerpoint presentation - Veavy'S Code

Extension of this idea:

Build an electron cross platform desktop app which is very helpful for corporate employees/students as a one stop solution for messaging, document collaboration, file sharing etc.. Instead of having 3-4 desktop apps for each purpose, you can have a single app consisting of all weavy's features which is a lot less development time, cross platform ready and easy to use.

What's Weavy?

The complete white-label framework for in-app messaging and collaboration. Different features of weavy are as follows:

1. Instant Messaging
2. Secure File Sharing
3. Activity Feeds
4. To-Do Tasks

CAUTION: THIS IS A PROTOTYPE WITH CLIENT SIDE JWT TOKEN AUTHENTICATION. DO NOT RUN IN PRODUCTION

Mandatory Prerequisites before installation

1. Download and install Visual Studio Code - Download Link
2. Install the latest version of Nodejs
3. Install npm
4. Install Git
5. Install TypeScript

Installing in your local environment:

The steps to install in your local environment are as follows:

1. Get the Veavy'S Server Up and Running
   Caution: Mention the clientId as "clientId" and clientSecret as "clientSecret" in manage connections
2. Create a new space by name "demo" in weavy
3. Clone this repository using the following command

   git clone https://github.com/Better-Boy/veavy-code

4. Change the directory to veavy-code

   cd veavy-code

5. Open the code in visual studio code

   code .

6. Run npm install
7. Click "Start Debugging" from the Run Menu or F5
8. A new Vscode Window opens up with the extension loaded

Veavy's Code Settings:

There are certain settings that need to be done before using the extension. They are as follows:

1. Weavy: Url - Weavy Minimal Javascript with Jquery EndPoint Url - (Mandatory for all apps)
2. Weavy › User: Mail - Weavy User Mail - (Mandatory for all apps)
3. Weavy › Space: Key - Weavy Space Key - (Mandatory for all apps)
4. Weavy › Files: Key - Weavy Files Key - (Mandatory for files command)
5. Weavy › Messenger: Key - Weavy Messenger Key - (Mandatory for messenger command)
6. Weavy › Posts: Key - Weavy Posts Key - (Mandatory for posts command)
7. Weavy › Tasks: Key - Weavy Tasks Key - (Mandatory for tasks command)

In order to open the settings, click on the settings icon in bottom left corner of the visual code. Click on the settings tab.

Veavy'S Code Usage

Weavy has different apps for different purpose. Every app in the extension can be opened using a command. There are 4 different apps, hence 4 different commands.

Before invoking any of the commands, please fill the different settings mentioned above

1. Files App
2. Messenger App
3. Posts/Feeds App
4. Tasks App

Packaging the extension

1. Install vsce

   npm install -g vsce
   

2. Run the package command

   vsce package

3. A .vsix file will be generated
4. To install the extension

   code --install-extension <ext_name_version>.vsix

5. To uninstall the extension

   code --uninstall-extension <ext_name_version>.vsix

Known Issues:

1. Weavy + jquery minified url not able to load Sol: Give the correct weavy Weavy + jquery minified url endpoint
2. Authentication successful for Unknown User - This is due to client side jwt authentication
3. authorization-error/user-error - JWT token was invalid
4. Automatic creation of unknown spaces - This is the default behaviour in weavy
5. Blank Screen Appears - This is due to unknown error in the webview. Debug using the "Developer Tools" (Help - How to Open Developer Tools)

Improvements to be done

1. Server side JWT authentication
2. Better Error Handling
3. Disable auto-creation of spaces