{"id":"ambergracesoftware/dex","name":"dex","scope":"ambergracesoftware","platform":"roblox","description":"A library for building reactive user interfaces on Roblox","version":"0.1.7","latest":"0.1.7","versions":["0.1.4","0.1.5","0.1.6","0.1.7"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":false,"dependencies":{},"integrity":"8c4ad0b407b60016dcc363b91aecd1c1b057de49251271619e8da04525cb1e46","likes":0,"downloads":0,"install":"forest install ambergracesoftware/dex","url":"https://forest.dev/p/roblox/ambergracesoftware/dex","files":"https://api.forest.dev/ai/package/roblox/ambergracesoftware/dex/files","readme":"# Dex\n\n<p align=\"center\">\n    <img src=\"logo/Logo256.png\" />\n    <br/>\n    <br/>\n    Dex is a library for building reactive User Interfaces on Roblox.\n    <br/>\n    <br/>\n</p>\n\nDex provides tools to prototype animated, responsive UI Components, and\nmanage state across an entire Roblox project. Dex Components can be written\nentirely in Luau, or use premade assets built using Studio's UI editor.\n\n<br/>\n\n| DISCLAIMER: Dex is a work in progress, and does NOT currently have a full release! Please do not use Dex in production-bound code until v1.0.0 has been released. |\n| --- |\n\n<br/>\n\n# Documentation\n\nPlease see the [Documentation Site](https://dex.ambergracesoftware.com) for\ntutorials, a full API reference, and more!\n\n<br/>\n\n# Installation\n\nDex can either be imported into your Roblox project, or installed via Wally.\n\n#### Roblox Studio Installation\n\nTo add Dex to your Roblox Studio project, download the\n[latest `.rbxmx` release from Github](https://github.com/AmberGraceSoftware/Dex/releases/latest),\nthen drag the model file into Roblox Studio. Place the Dex library somewhere in\nReplicatedStorage.\n\n#### Rojo + Wally Installation\n\nTo install Dex using Wally, first install [Rojo](https://rojo.space/docs/v7/)\nand [Wally](https://wally.run/install), then search for the last published Dex\nrelease on the [Wally website](https://wally.run/package/ambergracesoftware/dex),\nor run the following command to get the latest version:\n```sh\n$ wally search ambergracesoftware/dex\n```\nTo add Dex to your project, add an entry under the `[dependencies]` section of\nyour project's `wally.toml` file, replacing `X.Y.Z` with Dex's latest version\nnumber:\n```toml\nDex = \"ambergracesoftware/dex@X.Y.Z\"\n```\n\nFinally, run\n```sh\n$ wally install\n```\nOn the command line to get have the latest install added to your project's\nPackages folder.\n\nIt is also recommended you run the\n[wally-package-types](https://crates.io/crates/wally-package-types) tool after\ninstalling or updating Dex, as well as the\n[Luau LSP](https://github.com/JohnnyMorganz/luau-lsp) in order to utilize Dex\nwith Luau's type safety features.\n\n<br/>\n\n# Contributing\n\nTo contribute to Dex's development, you may fork this repository.\n\nDex uses the following toolchain for library development:\n- [aftman](https://github.com/LPGhatguy/aftman)\n    - Run `aftman install` in the root directory\n    - Run `wally install` to install Dex's dev dependencies (i.e. testez)\n- [Visual Studio Code](https://code.visualstudio.com/)\n- [Luau LSP VS Code Extension](https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.luau-lsp), which should be configured to include the testez declaration file.\n![](https://i.imgur.com/x9LjJDy.png)\n- [Selene VS Code extension](https://marketplace.visualstudio.com/items?itemName=Kampfkarren.selene-vscode)\n- [Moonwave](https://eryn.io/moonwave/)\n    - Install via `npm i -g moonwave@latest`\n    - Run `moonwave dev` to live test the docs site in your local branch\n\nDex uses unit testing to validate code quality. Because Roblox Studio tests\ncannot currently be fully automated, unit tests must be run manually before\nchanges can be merged into the main branch. To perform this process:\n- Sync the build via `rojo build --output Dex.rbxlx`\n- Set `workspace.SignalBehavior` to `Immediate`, as some unit tests require this to be true.\n- Open the build in Roblox Studio, and run the command line script located in `game.ServerScriptStorage.TestRunner`\n- Copy the \"proof checksum\" generated in Studio's output and replace the contents `testing_proof_checksum.txt` with this checksum, then commit this directly to the branch.\n- Github will automatically start an action which compares the source code with the proof checksum. If it matches, and the unit tests were all successful, the current branch will be marked as safe to merge.\n","readmeTruncated":false}