mirror of
https://github.com/finos/SymphonyElectron.git
synced 2024-11-29 20:24:10 -06:00
46 lines
2.9 KiB
Markdown
46 lines
2.9 KiB
Markdown
[](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)
|
|
[](https://symphonyoss.atlassian.net/wiki/display/FM/Incubating)
|
|
[](https://github.com/symphonyoss/SymphonyElectron/actions/workflows/ci.yml)
|
|
[](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
|