if/SymphonyElectron
1
0
Fork 0
mirror of https://github.com/finos/SymphonyElectron.git synced 2024-12-28 09:51:06 -06:00
Code Issues Packages Projects Releases Wiki Activity
A desktop client for the Symphony Collaboration Platform built using Electron
755 Commits 50 Branches 67 Tags 204 MiB
TypeScript 55.3%
C# 27.5%
Rich Text Format 5.8%
Less 3.5%
HTML 3.3%
Other 4.5%
08c25e4b58
Go to file
Kiran Niranjan 08c25e4b58 Electron-256 (Changed the implementation from modal to electron window) (#308) 
1. Completed functionality
2. Refactored and added code comments
3. Fixed some style issues
4. Added some safety checks
5. Updated Window size
6. Added some safety checks
7. Fixed some keyboard interaction
8. Fixed styles for Windows OS
9. Added a functionality to place screen picker based on the event sender
10. Updated the code to open the screen picker on top of the focused window instead of finding a ref using window name
11. Added a HTML content to display error message
12. Updated window title
13. Added missing return
14. Changed the method name from `openScreenPickerWindowWindow` to `openScreenPickerWindow`
15. Fixed a typo and added code comment
16. Changes as per PR review
17. Created Enum for key code
18. Updated for loop to for..of loop
19. Updated colors from hex to rgba
20. Setting cursor property as pointer for cancel button and item-container
21. Made window draggable
22. Changed font-family to system fonts
23. Added box shadow for buttons
24. Added a new API to support backward compatibility and deprecated the existing one
25. Fixed the condition prevent a new window from being opened if there is an existing window
2018-03-09 15:31:44 +05:30
build update dmg img 2017-02-13 16:31:42 -08:00
config Electron-308 - Rebased and squash commits 2018-02-20 20:41:04 +05:30
demo Electron-256 (Changed the implementation from modal to electron window) (#308) 2018-03-09 15:31:44 +05:30
installer ELECTRON-307 : add 32 bit windows installer support (#313) 2018-03-07 22:22:27 +05:30
js Electron-256 (Changed the implementation from modal to electron window) (#308) 2018-03-09 15:31:44 +05:30
tests Electron-308 Removed messages from constants and hardcoded it as per PR review 2018-02-27 09:24:40 +05:30
.eslintignore update to badget count interface (#32) 2017-03-09 10:12:28 -08:00
.eslintrc more ssf name-space updates (#79) 2017-05-08 10:46:56 -07:00
.gitignore ELECTRON-307 : add 32 bit windows installer support (#313) 2018-03-07 22:22:27 +05:30
LICENSE added LICENSE and NOTICE files 2016-12-03 00:59:30 +01:00
NOTICE added LICENSE and NOTICE files 2016-12-03 00:59:30 +01:00
package.json Electron-308 - Rebased and squash commits 2018-02-20 20:41:04 +05:30
PULL_REQUEST_TEMPLATE.md Electron-217 2017-12-11 22:41:34 +05:30
README.md Updated README 2017-11-20 16:35:27 +05:30

README.md

Symphony Software Foundation - Incubating

SymphonyElectron

About:

SymphonyElectron is a desktop client of the Symphony Communication Platform built for macOS, Windows 10 and Windows 7.

Project Goals:

Our goal is to improve the performance and development agility of Symphony's desktop wrapper and build a path to support other wrappers by:

  1. Standardizing the JS to native interfaces
  2. Standardizing the app to app interfaces (current embedding API)
  3. Provide an open and free reference implementation that anyone can contribute to, modify, and make derivative works.

In order to achieve those goals Symphony is participating and working in close collaboration with the Foundation Desktop Wrapper Working Group

Windows Dev Env

  • NodeJS version >= 7.4.0 (corresponds to electron 1.6.7)
  • install Microsoft Visual Studio 2015 with both C++ and .NET/C# development tools. Free community versions works.
  • also make sure .NET3.5SP1 is installed.
  • note: C++ tools needed to recompile node modules
  • note: .NET/C# tools needed to compile screen-snippet
  • open 'Developer Command Prompt for VS2015' - this sets paths to visual studio build tools

Mac Dev Env

  • need to install xcode command line tools.
  • NodeJS version >= 7.4.0 (corresponds to electron 1.6.7) - needed to run tests locally

Run demo:

  • npm install
  • npm run demo-win (for windows)
  • npm run demo-mac (for mac osx)

Build Instructions:

  • npm install
  • to run locally: npm run dev
  • to build mac pkg:
  • to build win msi: npm run unpacked-win (for 64 bit) and use 'advanced installer' .aip file in installer/ dir

msi command line options:

  • to install for all users (admin required): msiexec.exe /i Symphony-x64.msi ALLUSERS=1
  • to install per user: msiexec.exe /i Symphony-x64.msi ALLUSERS=""
  • to change default pod url: msiexe.exe /i Symphony-x64.msi POD_URL=my.symphony.com
  • to change auto start: msiexe.exe /i Symphony-x64.msi AUTO_START=true (or false) - if not specified default it true.
  • to change minimize on close: msiexe.exe /i Symphony-x64.msi MINIMIZE_ON_CLOSE=true (or false) - if not specified default is true.
  • any of the above options can be chained together, for example: msiexe.exe /i Symphony-x64.msi MINIMIZE_ON_CLOSE=true AUTO_START=false POD_URL=my.symphony.com

Start URL

  • To change the start url (i.e., pod url), edit config/Symphony.config and change 'url' variable. if no protocol provided, then https will be added.
  • The installer will include file config/Symphony.config next to executable. Changes in this file will effect all users.

Tests and Code Coverage

  • jest framework is used to run tests: http://facebook.github.io/jest/
  • to run tests and get code coverage report: npm test
  • code coverage reports are placed in dir: converage
  • tests are located in dir: tests

Logging

  • Local logging is enabled for dev environments using the module electron-log
  • On macOS, the logs are stored under ~/Library/Logs/<app name>/log.log
  • On Windows, the logs are stored under %USERPROFILE%\AppData\Roaming\<app name>\log.log
  • Remote logging is enabled for local and production cases and are sent to the backend server via the remote objects

Misc notes

  • If desiring to run against server without proper cert use cmd line option: --ignore-certificate-errors
  • To start additional instance with custom data directory (if you want seperate user) use cmd line options: --multiInstance --userDataPath=
    • if directory doesn't exist, it will be created