search

maxmert / maxmertkit

Maxmertkit, powerful, most customizable and easiest for usage mobile first front-end framework for web-development.
maxmert.com
MIT License
482 stars 70 forks source link

readme

Maxmertkit

[NOT SUPPORTED ANYMORE]

Join the chat at https://gitter.im/maxmert/maxmertkit

Build Status

Maxmertkit, powerful, most customizable and easiest for usage mobile first front-end framework for web-development, created by Vetrenko Maxim, and maintained by the core team with the support and involvement of the community.

To get started, check out http://maxmert.com!

Table of contents

Quick start

Three quick start options are available:

Read the Start page for information on the framework contents, howto videos, examples, and more.

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations.

Bugs, errors and feature requests

Have a bug, text error or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Maxmertkit's documentation, included in this repo in the root directory, is run with Nodejs. The docs may be run locally.

Running documentation locally

Go to maxmert.com/start and watch HOWTO video

  1. If necessary, install Nodejs, install NPM, install Bower.
  2. From the root /maxmertkit directory, run npm install in the command line.
  3. Run bower install in the command line.
  4. From the /docs directory, run npm install in the command line.
  5. From the /docs directory, run bower install in the command line.
  6. From the root /maxmertkit directory, run gulp in the command line.
  7. Open http://localhost:3333 in your browser.

Documentation for previous releases

Documentation for v0.0.2 has been made available for the time being at http://old.maxmert.com while folks transition to Maxmertkit 1.0.0.

Compiling CSS and JavaScript

Maxmertkit uses Gulp with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Gulp commands.

Install Gulp

From the command line:

  1. Install gulp globally with npm install -g gulp (maybe you'll need to run it with sudo – sudo npm install -g gulp).
  2. Read about running documentation locally.

When completed, you'll be able to run the various Gulp commands provided from the command line.

Unfamiliar with npm? Don't have node installed? That's a-okay. npm stands for node packaged modules and is a way to manage development dependencies through node.js. Download and install node.js before proceeding.

Available Gulp commands

Build and watch (development) - gulp

Run gulp to run buld and run documentation locally. It will compile coffeescript and sass into /docs and run nodemon server at port 3333.

Only compile CSS and JavaScript (production) - gulp build

Run gulp build to clear the /build directory and recompile all coffeescript and sass files with gzip and standart version.

Tests - gulp test

Troubleshooting dependencies

Should you encounter problems with installing dependencies or running Gulp commands, uninstall all previous dependency versions (global and local). Then, rerun npm install and bower install in the root and /docs directory.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, please include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Community

Keep track of development and community news.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Maxmertkit is maintained under the Semantic Versioning guidelines. Sometimes I screw up, but I'll adhere to these rules whenever possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

For more information on SemVer, please visit http://semver.org/.

Author

Vetrenko Maxim

Copyright and license

Code and documentation copyright 2012-2014 Maxmert. Code released under the MIT license. Docs released under Creative Commons.

Bitdeli Badge