https://imba.github.io/imba-guide/
A quick guide to Imba
https://imba.github.io/imba-guide/
Last synced: about 1 year ago
JSON representation
A quick guide to Imba
- Host: GitHub
- URL: https://imba.github.io/imba-guide/
- Owner: imba
- Archived: true
- Created: 2018-11-24T09:52:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-06T18:24:38.000Z (over 6 years ago)
- Last Synced: 2025-03-05T08:43:07.636Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://imba.github.io/imba-guide/
- Size: 588 KB
- Stars: 20
- Watchers: 8
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-imba - Imba more depth Guide
README
:no_entry: [DEPRECATED] Please use https://github.com/imba/imba.io
# Imba guide
This is a quick guide to the [Imba](http://imba.io/) language and web
development platform.
Imba is a general purpose programming language that compiles to JavaScript and
is optimized for writing performant front end web applications.
## Requirements
System packages:
- [Python](https://www.python.org/downloads/) (for documentation generator)
- [NodeJS](https://nodejs.org/en/) (for the playground)
Install the dependencies for the Sphinx documentation generator:
- Go into the repository directory
- Run `pip install -r requirements.txt`
Install the dependencies for the playground:
- Go into the repository directory
- Run `npm install`
## Quick start
To build the documentation, go to the project directory and run
`npm run build:docs`.
The compiled documentation should be present in `site/index.html`. Open
that file in your browser.
You can also read the source Markdown files [directly](docs/index.md).
## Using the playground
The playground is a simple Imba module that is set up to compile using Webpack.
The idea is to open the compiled code and the source side-by-side and compare
the source to the output.
To start the automatic compilation, run `npm run watch`. The compiled
JavaScript will appear in `dist/client.js`.
To start the development web server, run: `npm run start`.
**NOTE:** The development server will not compile your playground code into
`dist/client.js`, so if you wish to keep track of the compiler output, you
should run both `watch` and `start` scripts
## Directory structure
- `docs/` - documentation source (`index.md` is the starting point)
- `build/` - generated HTML for the documentation (appears after running
`npm run build:docs`)
- `code/` - playground code
- `dist/` - compiled JavaScript for the playground
## Contributing
If you wish to contribute to this project, you may find it helpful to know
that the project uses [MkDocs](https://www.mkdocs.org/). The
`npm run watch:docs` command will spin up a local server on port `8000` that
will update as you edit.
## Publishing the docs on GitHub Pages
The documentation is published to GitHub Pages with `npm run gh-publish`.