Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/revery-ui/revery

:zap: Native, high-performance, cross-platform desktop apps - built with Reason!
https://github.com/revery-ui/revery

app cross-platform desktop desktop-apps electron native ocaml react reason reasonml ui

Last synced: 4 days ago
JSON representation

:zap: Native, high-performance, cross-platform desktop apps - built with Reason!

Host: GitHub
URL: https://github.com/revery-ui/revery
Owner: revery-ui
License: mit
Created: 2018-09-19T16:09:22.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2022-02-13T22:31:10.000Z (over 2 years ago)
Last Synced: 2024-10-29T15:03:58.684Z (7 days ago)
Topics: app, cross-platform, desktop, desktop-apps, electron, native, ocaml, react, reason, reasonml, ui
Language: Reason
Homepage: https://www.outrunlabs.com/revery/
Size: 6.73 MB
Stars: 8,072
Watchers: 78
Forks: 197
Open Issues: 114
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-repositories - revery-ui/revery - :zap: Native, high-performance, cross-platform desktop apps - built with Reason! (Reason)
awesome-github-star - revery - performance, cross-platform desktop apps - built with Reason! | revery-ui | 8050 | (Reason)
awesome-list - revery - performance, cross-platform desktop apps - built with Reason! | revery-ui | 7664 | (Reason)
StarryDivineSky - revery-ui/revery - 使用 Reason，Revery 有点像超快的原生代码 Electron - 捆绑了类似 React/Redux 的库和快速构建系统，Revery 是用 reasonml 构建的，reasonml 是 OCaml 之上的类似 javascript 的语法，这意味着 JS 开发人员可以使用该语言。您的应用程序使用 Reason/OCaml 工具链编译为原生代码 - 具有与原生 C 代码相当的即时启动和性能。Revery 具有平台加速、GPU 加速的渲染功能。编译器本身也很快！ (前端开发框架及项目 / 其他_文本生成、文本对话)
jimsghstars - revery-ui/revery - :zap: Native, high-performance, cross-platform desktop apps - built with Reason! (Reason)

README

        


	

		

	





  Build native, high-performance, cross-platform desktop apps with reason!





  

  

    

  

  

    

  

  

    

  

  

    

  



---



	

		

	



:construction: __NOTE:__ Revery is a work-in-progress and in active development! :construction:

To get a taste of Revery, check out our JavaScript + WebGL build on the [playground](https://outrunlabs.com/revery/playground). For the best experience, though, you'll want to try a [native build](https://github.com/revery-ui/revery/wiki/Building-&-Installing).

## Motivation

Today, [Electron](https://electronjs.org/) is one of the most popular tools for building desktop apps - using an HTML, JS, CSS stack. However, it has a heavy footprint in terms of both RAM and CPU - __essentially packing an entire browser into the app.__ Even with that tradeoff, it has a lot of great aspects - it's the quickest way to build a cross-platform app & it provides a great development experience - as can be testified by its usage in popular apps like VSCode, Discord, and Slack.

Revery is kind of like super-fast, _native code_ Electron - with bundled React-like/Redux-like libraries and a fast build system - all ready to go!

Revery is built with [reasonml](https://reasonml.github.io), which is a javascript-like syntax on top of [OCaml](https://ocaml.org) This means that the language is accessible to JS developers.

Your apps are compiled to native code with the Reason / OCaml toolchain - with __instant startup__ and __performance comparable to native C code.__ Revery features platform-accelerated, GPU-accelerated rendering. The compiler itself is fast, too!

Revery is an experiment - can we provide a great developer experience and help teams be productive, without making sacrifices on performance?

### Design Decisions

- __Consistent cross-platform behavior__

A major value prop of Electron is that you can build for all platforms at once. You have great confidence as a developer that your app will look and work the same across different platforms. Revery is the same - aside from platform-specific behavior, if your app looks or behaves differently on another platform, that's a bug! As a consequence, Revery is like [flutter](https://flutter.io) in that it __does not use native widgets__. This means more work for us, but also that we have more predictable functionality cross-platform!

> __NOTE:__ If you're looking for something that does leverage native widgets, check out [briskml](https://github.com/briskml/brisk). Another alternative is the [cuite](https://github.com/let-def/cuite) OCaml binding for [Qt](https://github.com/let-def/cuite).

- __High performance__

Performance should be at the forefront, and not a compromise - we need to develop and build benchmarks that help ensure top-notch performance and start-up time.

- __Type-safe, functional code__

We might have some dirty mutable objects for performance - but our high-level API should be purely functional. You should be able to follow the React model of modelling your UI as a _pure function_ of application state -> UI.

## Getting Started

- Check out [revery-quick-start](https://github.com/revery-ui/revery-quick-start) to get up and running with your own Revery app!

- Try out our [interactive playground](https://www.outrunlabs.com/revery/playground/)

- Read through our [docs](https://www.outrunlabs.com/revery/api/revery/)

## Contributing

We'd love your help, and welcome PRs and contributions.

Some ideas for getting started:

- [Build and run](https://github.com/revery-ui/revery/wiki/Building-&-Installing) Revery

- View our [Roadmap](https://github.com/revery-ui/revery/wiki/Roadmap)

- Help us improve our [documentation](https://github.com/revery-ui/revery/blob/master/src/index.mld)

- Help us build [examples](https://github.com/revery-ui/revery/tree/master/examples)

- Help us [fix bugs](https://github.com/revery-ui/revery/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+label%3A%22bug%22) and [build features](https://github.com/revery-ui/revery/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22++-label%3Abug)

- Help us [log bugs and open issues](https://github.com/bryphe/revery/issues/new)

- Support the project on [OpenCollective](https://opencollective.com/revery)

- Follow us on [Twitter](https://twitter.com/reveryui) or chat with us on [Discord](https://discord.gg/UvQ2cFn)!

## License

Revery is provided under the [MIT License](LICENSE).

Revery bundles several dependencies under their own license terms - please refer to [ThirdPartyLicenses.txt](./ThirdPartyLicenses.txt).

## Contributors

Thanks to everyone who has [contributed](https://github.com/revery-ui/revery/graphs/contributors) to Revery!

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/revery#backer)]



## Built with Revery



  

    

  



## Special Thanks

`revery` would not be possible without a bunch of cool tech:

- [ocaml](https://ocaml.org) made these tools possible - thanks [Inria](http://gallium.inria.fr/) & [OCaml Labs](http://ocamllabs.io/)!

- [reasonml](https://reasonml.github.io) made revery possible - thanks @jordwalke!

- [flex](https://github.com/jordwalke/flex) by @jordwalke

- [briskml](https://github.com/briskml)

    - [brisk-reconciler](https://github.com/briskml/brisk-reconciler) - the "native React" implementation.

- [reason-sdl2](https://github.com/revery-ui/reason-sdl2)

    - [SDL2](https://www.libsdl.org)

    - [stb-image](https://github.com/nothings/stb)

- [reason-fontkit](https://github.com/bryphe/reason-fontkit)

    - [freetype2](https://www.freetype.org)

    - [harfbuzz](https://www.freedesktop.org/wiki/Software/HarfBuzz)

- [reason-gl-matrix](https://github.com/bryphe/reason-gl-matrix)

    - [gl-matrix](http://glmatrix.net)

    - [glm](https://glm.g-truc.net/0.9.9/index.html)

- [@reason-native/console](https://github.com/facebookexperimental/reason-native/tree/master/src/console)

`revery` was inspired by some __awesome projects:__

- [react-native](https://facebook.github.io/react-native/)

- [ReactMini](https://github.com/reasonml/reason-react/tree/master/ReactMini)

- [cuite](https://github.com/let-def/cuite)

- [wall](https://github.com/let-def/wall)

- [elm](https://elm-lang.org/)

- [reprocessing](https://github.com/Schmavery/reprocessing)

# Hot reload

We don't have a Hot Reload yet but it is on our roadmap. In the meantime, you can check branch [feat/hot-reload](https://github.com/revery-ui/revery/tree/feat/hot-reload) to see the progression.

In the meantime @mbernat has done a [script](https://gist.github.com/mbernat/abf651653c123374037c27377f41d0a0) that allow to relaunch the APP when the binary changed.