Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/outsystems/reactview
ReactView is a framework for building react.js based UIs that can be hosted in Avalonia/WPF applications
https://github.com/outsystems/reactview
avaloniaui browser desktop-app macos odc reactjs snyk-service-studio typescript webview windows wpf
Last synced: 26 days ago
JSON representation
ReactView is a framework for building react.js based UIs that can be hosted in Avalonia/WPF applications
- Host: GitHub
- URL: https://github.com/outsystems/reactview
- Owner: OutSystems
- License: apache-2.0
- Created: 2020-10-05T11:32:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T00:45:23.000Z (about 2 months ago)
- Last Synced: 2024-10-04T19:04:38.275Z (about 1 month ago)
- Topics: avaloniaui, browser, desktop-app, macos, odc, reactjs, snyk-service-studio, typescript, webview, windows, wpf
- Language: C#
- Homepage:
- Size: 10.2 MB
- Stars: 31
- Watchers: 19
- Forks: 6
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReactView
ReactView is a framework for building react.js based UIs that can be hosted in Avalonia/WPF applications.
Using this framework you can build .NET desktop applications that run on Windows or macOS (using the Avalonia version) and mix TypeScript and .NET code in the same app in a seamless way.
## Documentation
See the [Sample.Avalonia](Sample.Avalonia) project for an example of a Task List application that showcases most of the functionalities provided by this framework.
## Getting Started
1) Add the ReactViewControl-Avalonia (or ReactViewControl-WPF) and ViewGenerator Nuget packages to your WPF/Avalonia project.
2) Follow [these](ViewGenerator/readme.txt "Instructions") intructions
3) For more details check the Sample project.
## Releases
Stable binaries are released on NuGet, and contain everything you need to start creating ReactView based apps.
- [](https://www.nuget.org/packages/ReactViewControl-Avalonia/)
- [](https://www.nuget.org/packages/ReactViewControl-WPF/)
- [](https://www.nuget.org/packages/ViewGenerator/)
# View Generator
ViewGenerator is the companion tool of the ReactView framework which generates the C# code from the TypeScript declarations and is responsible for compiling and packing all the application assets into the app bundle.
## Build pre-requisites
- NodeJS
## ViewPacker
We have a node package, _**node-sass**_ which creates a folder of vendors for each OS. However, to generate these vendors, the following command needs to run in each OS:
Inside ViewPacker with node_modules installed, the user should run `node scripts/install.js` which will generate a new vendor folder inside `node_modules/node_sass/vendor/` for the user's selected OS. This new vendor folder (e.g. `darwin-x64-72/`) and its **binding.node** content file shall then be added to ViewPacker's `build/node-sass-vendors/`.
For now we are using the following node versions:
- 10.16.3
- 12.18.4
**Note:** If you wish to upgrade the node version at use, don't forget to delete/replace any previous bindings related to the OS (`darwin-x64-72/` represents node 12.X.X's version).
## Versioning
The versioning system works as follows:
`..`
Whenever you fix a bug, please increase the patch version. \
Whenever you bring a new feature, please increase the major version. \
Use the minor version for the current cef version.
# TODO
- Improve documentation