{"id":13467409,"url":"https://github.com/revery-ui/revery-quick-start","last_synced_at":"2025-08-19T22:32:36.254Z","repository":{"id":50773142,"uuid":"154910363","full_name":"revery-ui/revery-quick-start","owner":"revery-ui","description":"Quick Start / Sample Revery Application","archived":false,"fork":false,"pushed_at":"2021-05-30T10:05:56.000Z","size":833,"stargazers_count":176,"open_issues_count":9,"forks_count":28,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-12-16T02:52:09.405Z","etag":null,"topics":["ocaml","reason","revery","ui"],"latest_commit_sha":null,"homepage":"https://www.outrunlabs.com/revery/","language":"Reason","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/revery-ui.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-27T01:05:01.000Z","updated_at":"2024-11-27T19:19:19.000Z","dependencies_parsed_at":"2022-09-11T11:00:45.076Z","dependency_job_id":null,"html_url":"https://github.com/revery-ui/revery-quick-start","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-quick-start","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-quick-start/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-quick-start/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revery-ui%2Frevery-quick-start/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/revery-ui","download_url":"https://codeload.github.com/revery-ui/revery-quick-start/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230226635,"owners_count":18193187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ocaml","reason","revery","ui"],"created_at":"2024-07-31T15:00:56.014Z","updated_at":"2024-12-19T04:07:34.048Z","avatar_url":"https://github.com/revery-ui.png","language":"Reason","funding_links":[],"categories":["Reason"],"sub_categories":[],"readme":"[![Build Status](https://dev.azure.com/revery-ui/revery/_apis/build/status/revery-ui.revery-quick-start?branchName=master)](https://dev.azure.com/revery-ui/revery/_build/latest?definitionId=4?branchName=master)\n\n# Revery Quick Start\n\nThis is a minimal Revery application to get you started.\n\n## Prerequisites\n\nSee the [requirements for building Revery](https://github.com/revery-ui/revery/wiki/Building-\u0026-Installing)\n\n## Getting started\n\n```\n# Clone the repository\ngit clone https://github.com/revery-ui/revery-quick-start\n\n# Go into the repository\ncd revery-quick-start\n\n# Install dependencies\nesy install\n\n# Build dependencies\nesy build\n```\n\n\u003e **NOTE:** The first build will take a while - building the OCaml compiler and dependencies takes time! Subsequent builds, though, should be very fast.\n\nOnce built, the application binary will be in the `_build/install/default/bin` - you can run it like:\n\n- `_build/install/default/bin/App`\n\nor using esy with the script specified in [package.json](package.json#L8):\n\n- `esy run`\n\n## What are all these files?\n\nThe most important files are:\n\n- [`src/App.re`](./src/App.re) - This is the core application code, responsible for **creating a window** and **rendering**.\n- [`src/SimpleButton.re`](./src/SimpleButton.re) - A simple button with hover and active-styling.\n- [`src/AnimatedText.re`](./src/AnimatedText.re) - A component showcasing some neat animations.\n- [`src/Theme.re`](./src/Theme.re) - A module holding some colors etc.\n\nA Revery application also needs the following files:\n\n- [`package.json`](package.json) - [esy configuration](https://esy.sh/docs/en/configuration.html) - lists the Reason/OCaml dependencies.\n- `dune` / `dune-project` - build configuration files used by [Dune](https://dune.readthedocs.io/en/latest/).\n- `.opam` - metadata used by the build system.\n\n## Releasing\n\nTo create packages for distribution, follow these steps:\n\n- `npm install -g revery-packager`\n\nFrom the `revery-quick-start` folder, run:\n\n- `revery-packager`\n\nOnce complete, there will be application packages available in the `_release` folder.\n\n## Resources\n\n- Check out the [Reason-documentation](https://reasonml.org) to learn more about Reason\n- Visit the Reason [Discord-channel](https://discordapp.com/invite/reasonml) and say hi!\n\n## Next steps\n\nHere's a few challenges to see if you've got the basics:\n\n- Add an Image component\n- Respond to user input\n- Create a frameless window\n\n## License\n\n[MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevery-ui%2Frevery-quick-start","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevery-ui%2Frevery-quick-start","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevery-ui%2Frevery-quick-start/lists"}