https://github.com/acauamontiel/mantis-ui

The fastest and most up-to-date modular front-end framework
https://github.com/acauamontiel/mantis-ui

browserify es6 flexbox gulp mantis-ui pug stylus

Last synced: about 19 hours ago
JSON representation

The fastest and most up-to-date modular front-end framework

• Host: GitHub
• URL: https://github.com/acauamontiel/mantis-ui
• Owner: acauamontiel
• Created: 2015-04-02T23:43:03.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-06-25T19:52:27.000Z (over 5 years ago)
• Last Synced: 2024-11-13T19:33:21.382Z (about 1 month ago)
• Topics: browserify, es6, flexbox, gulp, mantis-ui, pug, stylus
• Language: JavaScript
• Homepage: http://acauamontiel.github.io/mantis-ui
• Size: 1000 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


Mantis UI

=========

> The fastest and most up-to-date modular front-end framework

Get started

-----------

First of all, you need to have installed [Node.js](http://nodejs.org/) and [Gulp](http://gulpjs.com) globally.

Then you can install by running the following command in your terminal:

```shell

sh -c "$(curl -fsSL https://raw.githubusercontent.com/mantis-stack/mantis-ui/master/install.sh)"

```

Otherwise you can install *"manually"* doing the following steps:

- Clone the repo: `git clone [email protected]:mantis-stack/mantis-starter.git my-project`

- Enter the folder: `cd my-project`

- Install Node dependencies: `npm install`

- Finally install Bower components: `bower install`

But I recommend you to install the easiest way.

Running

-------

You can run the app locally by [Gulp](http://gulpjs.com)

### Available Gulp commands

#### Default - `gulp`

Run `gulp` to compile and watch files running on [localhost:3000](http://localhost:3000)

#### Build - `gulp build`

Run `gulp build` to only compile files

#### Dist - `gulp dist`

Run `gulp dist` to compile, optimize and minify files

#### Clean - `gulp clean`

Run `gulp clean` to delete the `build/` folder (same as `rm -rf build`)

Structure

---------

When you have all installed, the structure will look like this:

```

node_modules/

src/

├── dependencies/

├── copy/

│   ├── fonts/

│   │   └── *.{eot|svg|ttf|woff}

│   ├── **/*

├── css/

│   ├── components/

│   │   └── *.styl

│   ├── core/

│   │   └── *.styl

│   └── style.styl

├── fonts/

│   └── *.{eot|svg|ttf|woff}

├── html/

│   ├── incs/

│   │   └── *.jade

│   ├── layouts/

│   │   └── *.jade

│   └── index.jade

├── img/

│   ├── backgrounds/

│   │   └── *.{jpg|png|svg}

│   ├── favicons/

│   │   └── *.{png|svg}

│   ├── sprite/

│   │   └── *.svg

│   └── *.{jpg|png|svg}

└── js/

    ├── app/

    │   ├── index.js

    │   └── *.js

    ├── modules/

    │   └── *.js

    └── app.js

.babelrc

.bowerrc

.editorconfig

.eslintrc

.gitattributes

.gitignore

bower.json

content.json

gulpfile.babel.js

gulpfile.paths.js

logo.png

logo.svg

package.json

README.md

```

License

-------

© 2016 - 2017 [Acauã Montiel](http://acauamontiel.com.br)

[MIT License](http://acaua.mit-license.org/)