IcaliaLabs / Alom

Alom is the lighest, simplest framework ever, it will help you to kick up your project without interfering with any style, it is designed to make your life simpler and to help you deal with all the responsive stuff.

To get started, checkout:

http://icalialabs.github.io/alom/

Table of contents

• Getting started
• Running locally
• Documentation
• Contributing
• License

Getting started

Using Alom is extremely easy, we've provided two quick start options:

• Download the latest release.
• Clone the repo: git clone [email protected]:IcaliaLabs/alom.

We recommend you read the documentation for information about the class names and its implementation.

Running the framework

Locally

Make sure you have nodejs installed.

To use alom all you have to do is:

Alom depends on Gulp to run, so make sure you install it first. You can find installation instructions here.

After installing gulp, you need to install gulp-coffee by running:

% npm install gulp-coffee

Then:

1. Clone the repo: git clone [email protected]:IcaliaLabs/alom.git.
2. Change to the directory cd alom
3. Run npm install.
4. And finally run gulp.

The last command will open a browser tab with http://localhost:3014.

Using docker

To run alom using docker you only need to install docker.

After installing docker, you can run:

% docker-compose up -d

It may take a few seconds before you can actually see something at http://localhost:3014.

Documentation

You can find the documentation on how the framework works at https://icalialabs.github.io/alom/

Contributing

Please submit all pull requests against a separate branch. Please follow the standard for naming the variables, mixins, etc.

We use scss-lint to check for code styling, you can install it via the Gemfile by running bundle install

Make sure you have all the linting passing.

Thanks!

License

Code and documentation copyright 2016 Icalia Labs. Code released under the MIT license.