{"id":20279720,"url":"https://github.com/genieframework/geniebuilder.jl","last_synced_at":"2025-04-11T06:29:19.874Z","repository":{"id":36988677,"uuid":"461896975","full_name":"GenieFramework/GenieBuilder.jl","owner":"GenieFramework","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-17T09:18:57.000Z","size":77153,"stargazers_count":16,"open_issues_count":19,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-25T04:24:48.970Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GenieFramework.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-21T14:28:39.000Z","updated_at":"2024-03-20T00:55:19.000Z","dependencies_parsed_at":"2023-02-14T00:00:52.191Z","dependency_job_id":"3d7e0027-e0b2-4545-8bba-a7c8a226baa5","html_url":"https://github.com/GenieFramework/GenieBuilder.jl","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/GenieFramework%2FGenieBuilder.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenieFramework%2FGenieBuilder.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenieFramework%2FGenieBuilder.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GenieFramework%2FGenieBuilder.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GenieFramework","download_url":"https://codeload.github.com/GenieFramework/GenieBuilder.jl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248354451,"owners_count":21089820,"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":[],"created_at":"2024-11-14T13:32:39.094Z","updated_at":"2025-04-11T06:29:19.840Z","avatar_url":"https://github.com/GenieFramework.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GenieBuilder.jl\n\n\n## Installation\n\n### Optional: create a project for GenieBuilder\n\n```bash\n\u003e mkdir \"mygeniebuilder\"\n\u003e cd \"mygeniebuilder\"\n\u003e julia\n```\n\n```julia\npkg\u003e activate .\n```\n\nor install globally:\n\n```bash\n\u003e julia\n```\n\n### Install GenieBuilder\n\n```julia\npkg\u003e add https://github.com/GenieFramework/GenieBuilder.jl#v0.16\n```\n\nor\n\n```julia\npkg\u003e dev https://github.com/GenieFramework/GenieBuilder.jl#v0.16\n```\n\n## Usage\n\n```julia\njulia\u003e using GenieBuilder\n```\n\nThis will bring `GenieBuilder` into scope and start the GenieBuilder service. The service is responsible for managing the list of registered Genie apps, as well as the no-code editor.\n\nBy default, the service will start on port `10101` over HTTP, and on port `10102` for websockets.\n\n## Creating a boilerplate Genie app\n\n```julia\njulia\u003e GenieBuilder.create([name], [path])\n```\n\nAPI endpoint:\n```html\n/api/v1/apps/create?path=/Users/adrian/Projects/GenieBuilderNextGen\u0026name=testapp\n```\n\n-\u003e `name` is the name of the app, and `path` is the path to the app's directory. If `name` is not provided, the name of the app will be the name of the directory. If `path` is not provided, the current directory will be used.\n-\u003e returns information about the registered app\n\nThis will create a new Julia project in the current directory. You will see the new project files: `Project.toml`, `Manifest.toml` -- as well as the application itself: `app.jl` (for the backend) and `app.jl.html` (for the frontend/UI).\n\nUpon successfully creating the app, the new application is automatically registered with `GenieBuilder` so you can edit it with the no-code editor.\n\n## Working with the GenieBuilder API\n\nThe following functions are available to interact with `GenieBuilder`:\n\n### Get the list of apps registered with GenieBuilder\n\n```julia\njulia\u003e GenieBuilder.apps()\n```\n\n-\u003e Returns an array of `GenieBuilder.App` objects.\n\nAPI endpoint:\n\n```html\n/api/v1/apps\n```\n\n```json\n{\n  \"applications\": [\n    {\n      \"id\": {\n        \"value\": 1\n      },\n      \"name\": \"geniebuildernextgen\",\n      \"port\": 9101,\n      \"path\": \"/Volumes/Storage/Dropbox/Projects/GenieBuilderNextGen/\",\n      \"status\": \"offline\",\n      \"channel\": \"HSTYSOOKBWUMHXUZIABDTXFEHDEHHWIU\",\n      \"replport\": 9102\n    }\n  ]\n}\n```\n\n### Register an app with GenieBuilder\n\n```julia\njulia\u003e GenieBuilder.register([name], [path])\n```\n\n-\u003e `name` is the name of the app, and `path` is the path to the app's directory. If `name` is not provided, the name of the app will be the name of the directory. If `path` is not provided, the current directory will be used.\n-\u003e returns information about the registered app\n\nAPI endpoint:\n\n```html\n/api/v1/register\n```\n\n-\u003e GET payload: `name` and `path` (see above for expected data for both vars).\n\n#### Example\n\n```html\nhttp://127.0.0.1:10101/api/v1/apps/register?path=/Users/adrian/Projects/GenieBuilderNextGen\u0026name=testapp\n```\n\n```json\n{\n  \"id\": {\n    \"value\": 1\n  },\n  \"name\": \"testapp\",\n  \"port\": 9101,\n  \"path\": \"/Users/adrian/Projects/GenieBuilderNextGen/\",\n  \"status\": \"offline\",\n  \"channel\": \"SERRLQOMSCNRBLARTUZOZZYBSDAACOAF\",\n  \"replport\": 9102\n}\n```\n\n### Edit an app with the no-code editor\n\nIn order to edit an app with the no-code editor, the app must be registered with GenieBuilder and started (running). For more information on how to register an app, see the `register` function above.\n\n### Start an app\n\n```julia\njulia\u003e GenieBuilder.start(app::Application)\n```\n\nAPI endpoint:\n\n```html\n/api/v1/apps/\u003capp_id\u003e/start\n```\n\n-\u003e `app_id` is the ID of the app to start. The app must be registered with GenieBuilder.\n-\u003e `app` is an instance of `GenieBuilder.Application` (see `apps()` for more information).\n\n### Open no-code editor\n\n```julia\njulia\u003e GenieBuilder.editor(app::Application)\n```\n\nor\n\n```julia\njulia\u003e GenieBuilder.editor([name], [path])\n```\n\n### Stop an app\n\n```julia\njulia\u003e GenieBuilder.stop(app::Application)\n```\n\nAPI endpoint:\n\n```html\n/api/v1/apps/\u003capp_id\u003e/stop\n```\n\n-\u003e `app_id` is the ID of the app to stop. The app must be registered with GenieBuilder.\n-\u003e `app` is an instance of `GenieBuilder.Application` (see `apps()` for more information).\n\n### Get information about an app\n\nAPI endpoint:\n\n```html\n/api/v1/apps/\u003capp_id\u003e/pages\n```\n\n### Unregister an app\n\n```julia\njulia\u003e GenieBuilder.unregister(app::Application)\n```\n\nor\n\n```julia\njulia\u003e GenieBuilder.unregister([name], [path])\n```\n\nAPI endpoint:\n\n```html\n/api/v1/apps/\u003capp_id\u003e/unregister\n```\n\nor\n\nAPI endpoint:\n\n```html\n/api/v1/apps/unregister?path=/Users/adrian/Projects/GenieBuilderNextGen\u0026name=testapp\n```\n\n### Open app in browser\n\n```julia\njulia\u003e GenieBuilder.openbrowser(app::Application)\n```\n\n### Stop GenieBuilder\n\n```julia\njulia\u003e GenieBuilder.stop!()\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenieframework%2Fgeniebuilder.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenieframework%2Fgeniebuilder.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenieframework%2Fgeniebuilder.jl/lists"}