{"id":20236361,"url":"https://github.com/onyxframework/docs","last_synced_at":"2025-04-10T19:04:29.189Z","repository":{"id":95000676,"uuid":"159336995","full_name":"onyxframework/docs","owner":"onyxframework","description":"The Onyx Framework documentation 📚","archived":false,"fork":false,"pushed_at":"2021-04-20T17:29:42.000Z","size":1234,"stargazers_count":4,"open_issues_count":11,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T16:45:19.759Z","etag":null,"topics":["crystal","ruby"],"latest_commit_sha":null,"homepage":"https://docs.onyxframework.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onyxframework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-27T13:08:26.000Z","updated_at":"2022-04-13T11:59:23.000Z","dependencies_parsed_at":"2023-06-11T13:00:31.457Z","dependency_job_id":null,"html_url":"https://github.com/onyxframework/docs","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/onyxframework%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onyxframework%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onyxframework%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onyxframework%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onyxframework","download_url":"https://codeload.github.com/onyxframework/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248279197,"owners_count":21077406,"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":["crystal","ruby"],"created_at":"2024-11-14T08:20:24.807Z","updated_at":"2025-04-10T19:04:29.177Z","avatar_url":"https://github.com/onyxframework.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\nsidebarDepth: \"1\"\n---\n\n# Introduction\n\n## What is Onyx Framework\n\nOnyx Framework is a general purpose framework built on [Crystal, the Programming Language](https://crystal-lang.org). Crystal is, in turn, built on top of LLVM, which makes it **type-safe** and **incredibly fast**. Crystal syntax is heavily **inspired by Ruby**, which makes it a perfect language to replace slow Ruby code in your applications.\n\n## Design principles\n\nVery deep in the architecture of the framework lies an aim to be **perfect** from engineering point of view — true SOLID, loosely coupled components and **clean** architecture. But these idioms may be tedious for newcomers both to language and the framework and also require to write more boilerplate code.\n\nThat's why there is also a goal to hide the complexity under **simple** and **beautiful** DSL, but still be **extendable** and avaialble for more explict usage in the later stages of development cycle. The framework is able to grow with your knowledge of Crystal and your application needs.\n\n## Applications\n\nYou can use Onyx Frameworks to either create new projects from scratch or incrementally replace services in your existing applications. **Areas** where you can apply the framework include:\n\n* **Web** development, including real-time applications, as Onyx has first-class support for websockets\n* **Game server** development, as Onyx has tools to add reactivity\n* **Native platform applications**, as Onyx includes tools to work with embeddable databases like SQLite\n\nYou'd want to **switch** to Onyx and Crystal to:\n\n* Reduce **server costs** dramatically\n* Create **long-term** maintainable applications\n* **Catch bugs** in development, not in production, while writing fever tests\n* **Pay less** for migration, as Ruby developers usually learn Crystal in days\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonyxframework%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonyxframework%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonyxframework%2Fdocs/lists"}