{"id":13794723,"url":"https://imba.github.io/imba-guide/","last_synced_at":"2025-05-12T21:32:07.016Z","repository":{"id":138469941,"uuid":"158922906","full_name":"imba/imba-guide","owner":"imba","description":"A quick guide to Imba","archived":true,"fork":false,"pushed_at":"2019-10-06T18:24:38.000Z","size":602,"stargazers_count":20,"open_issues_count":3,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-05T08:43:07.636Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://imba.github.io/imba-guide/","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/imba.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-24T09:52:36.000Z","updated_at":"2024-08-28T23:23:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"9913569d-277a-4d6e-b8e3-d15e1421b225","html_url":"https://github.com/imba/imba-guide","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/imba%2Fimba-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imba%2Fimba-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imba%2Fimba-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imba%2Fimba-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imba","download_url":"https://codeload.github.com/imba/imba-guide/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253825160,"owners_count":21970142,"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-08-03T23:00:46.818Z","updated_at":"2025-05-12T21:32:06.669Z","avatar_url":"https://github.com/imba.png","language":"JavaScript","funding_links":[],"categories":["Resources"],"sub_categories":[],"readme":":no_entry: [DEPRECATED] Please use https://github.com/imba/imba.io\n\n# Imba guide\n\nThis is a quick guide to the [Imba](http://imba.io/) language and web \ndevelopment platform.\n\nImba is a general purpose programming language that compiles to JavaScript and \nis optimized for writing performant front end web applications.\n\n## Requirements\n\nSystem packages:\n\n- [Python](https://www.python.org/downloads/) (for documentation generator)\n- [NodeJS](https://nodejs.org/en/) (for the playground)\n\nInstall the dependencies for the Sphinx documentation generator:\n\n- Go into the repository directory\n- Run `pip install -r requirements.txt`\n\nInstall the dependencies for the playground:\n\n- Go into the repository directory\n- Run `npm install`\n\n## Quick start\n\nTo build the documentation, go to the project directory and run \n`npm run build:docs`.\n\nThe compiled documentation should be present in `site/index.html`. Open \nthat file in your browser.\n\nYou can also read the source Markdown files [directly](docs/index.md).\n\n## Using the playground\n\nThe playground is a simple Imba module that is set up to compile using Webpack.\nThe idea is to open the compiled code and the source side-by-side and compare\nthe source to the output.\n\nTo start the automatic compilation, run `npm run watch`. The compiled\nJavaScript will appear in `dist/client.js`.\n\nTo start the development web server, run: `npm run start`. \n\n**NOTE:** The development server will not compile your playground code into\n`dist/client.js`, so if you wish to keep track of the compiler output, you\nshould run both `watch` and `start` scripts\n\n## Directory structure\n\n- `docs/` - documentation source (`index.md` is the starting point)\n- `build/` - generated HTML for the documentation (appears after running \n  `npm run build:docs`)\n- `code/` - playground code\n- `dist/` - compiled JavaScript for the playground\n\n## Contributing\n\nIf you wish to contribute to this project, you may find it helpful to know\nthat the project uses [MkDocs](https://www.mkdocs.org/). The \n`npm run watch:docs` command will spin up a local server on port `8000` that \nwill update as you edit.\n\n## Publishing the docs on GitHub Pages\n\nThe documentation is published to GitHub Pages with `npm run gh-publish`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/imba.github.io%2Fimba-guide%2F","html_url":"https://awesome.ecosyste.ms/projects/imba.github.io%2Fimba-guide%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/imba.github.io%2Fimba-guide%2F/lists"}