SymphonyElectron/README.md

[![FINOS - Active](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-active.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Active)
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6746/badge)](https://bestpractices.coreinfrastructure.org/projects/6746)
[![Continuous Integration](https://github.com/symphonyoss/SymphonyElectron/actions/workflows/ci.yml/badge.svg)](https://github.com/symphonyoss/SymphonyElectron/actions/workflows/ci.yml)
[![Known Vulnerabilities](https://snyk.io/test/github/symphonyoss/SymphonyElectron/badge.svg?targetFile=package.json)](https://snyk.io/test/github/symphonyoss/SymphonyElectron?targetFile=package.json)

# SymphonyElectron

## About:

SymphonyElectron is a desktop client of the Symphony Communication Platform built for macOS, Windows 10, Windows 7
and Linux (experimental)
. We've built this using the popular [electron](https://github.com/electron/electron) framework to support cross platform desktop apps loaded in a chromium container.

## Contributing

1. Fork it (<https://github.com/symphonyoss/SymphonyElectron/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)
4. Commit your changes (`git commit -am 'Add some fooBar'`)
5. Push to the branch (`git push origin feature/fooBar`)
6. Create a new Pull Request

_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

_Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)_

## 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](https://symphonyoss.atlassian.net/wiki/display/WGDWAPI/Working+Group+-+Desktop+Wrapper+API)

## Development Setup & Running

Read [Dev Setup](docs/development/DEV_SETUP.md)

## License

The code in this repository is distributed under the Apache License, Version 2.0.

Copyright 2021 Symphony LLC
reflecting that project is active 2022-12-14 05:10:50 -06:00			`[![FINOS - Active](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-active.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Active)`
Adding best practices badge 2022-12-01 04:42:58 -06:00			`[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6746/badge)](https://bestpractices.coreinfrastructure.org/projects/6746)`
SDA-2530: update main branch 2021-03-03 00:54:47 -06:00			`[![Continuous Integration](https://github.com/symphonyoss/SymphonyElectron/actions/workflows/ci.yml/badge.svg)](https://github.com/symphonyoss/SymphonyElectron/actions/workflows/ci.yml)`
add synk badge to the repository 2019-12-05 00:51:36 -06:00			`[![Known Vulnerabilities](https://snyk.io/test/github/symphonyoss/SymphonyElectron/badge.svg?targetFile=package.json)](https://snyk.io/test/github/symphonyoss/SymphonyElectron?targetFile=package.json)`

Updating readme 2016-09-26 21:55:50 -05:00			`# SymphonyElectron`

#169: updated readme with a brief description As per suggestion here https://github.com/symphonyoss/SymphonyElectron/issues/169, added a brief description about the repo. 2017-11-16 04:15:30 -06:00			`## About:`

update setup guide (#1084) 2020-10-05 09:34:38 -05:00			`SymphonyElectron is a desktop client of the Symphony Communication Platform built for macOS, Windows 10, Windows 7`
SDA-2530: update main branch 2021-03-03 00:54:47 -06:00			`and Linux (experimental)`
update setup guide (#1084) 2020-10-05 09:34:38 -05:00			`. We've built this using the popular [electron](https://github.com/electron/electron) framework to support cross platform desktop apps loaded in a chromium container.`
#169: updated readme with a brief description As per suggestion here https://github.com/symphonyoss/SymphonyElectron/issues/169, added a brief description about the repo. 2017-11-16 04:15:30 -06:00
aligning README.md and CONTRIBUTING.md to FINOS project blueprint language (#672) 2019-06-04 07:26:19 -05:00			`## Contributing`

			`1. Fork it (<https://github.com/symphonyoss/SymphonyElectron/fork>)`
			2. Create your feature branch (`git checkout -b feature/fooBar`)
			`3. Read our [contribution guidelines](.github/CONTRIBUTING.md) and [Community Code of Conduct](https://www.finos.org/code-of-conduct)`
			4. Commit your changes (`git commit -am 'Add some fooBar'`)
			5. Push to the branch (`git push origin feature/fooBar`)
			`6. Create a new Pull Request`

Align "Contributing" section in README.md to FINOS project blueprint (#784) 2019-09-25 00:04:04 -05:00			_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool. Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.

SDA-2530: update main branch 2021-03-03 00:54:47 -06:00			`_Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org)_`
Align "Contributing" section in README.md to FINOS project blueprint (#784) 2019-09-25 00:04:04 -05:00
readme update (#20) 2017-02-22 18:24:26 -06:00			`## Project Goals:`
Updated Readme w/Project Goals per JC's guidance Added reference to project goals and Foundation Desktop Wrapper working group. 2016-12-14 12:04:23 -06:00
			`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](https://symphonyoss.atlassian.net/wiki/display/WGDWAPI/Working+Group+-+Desktop+Wrapper+API)`

update documentation and package configuration 2018-06-05 06:02:51 -05:00			`## Development Setup & Running`
readme updates for dev env readme updates for dev env 2017-04-22 10:34:41 -05:00
rearrange folder structure 2019-08-23 01:28:30 -05:00			`Read [Dev Setup](docs/development/DEV_SETUP.md)`
aligning README.md and CONTRIBUTING.md to FINOS project blueprint language (#672) 2019-06-04 07:26:19 -05:00
			`## License`
SDA-2530: update main branch 2021-03-03 00:54:47 -06:00
aligning README.md and CONTRIBUTING.md to FINOS project blueprint language (#672) 2019-06-04 07:26:19 -05:00			`The code in this repository is distributed under the Apache License, Version 2.0.`

update documentation 2021-03-25 08:02:03 -05:00			`Copyright 2021 Symphony LLC`