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

A modern kick-starter for front-end development packed with well-chosen tools
https://github.com/acauamontiel/mantis-starter

boilerplate browsersync es2015 es6 gulp jade pug scaffolding stylus svg-icons svg-sprites

Last synced: 2 months ago
JSON representation

A modern kick-starter for front-end development packed with well-chosen tools

• Host: GitHub
• URL: https://github.com/acauamontiel/mantis-starter
• Owner: acauamontiel
• Created: 2016-01-27T02:30:39.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-03-13T01:26:21.000Z (almost 5 years ago)
• Last Synced: 2024-10-01T06:36:05.421Z (3 months ago)
• Topics: boilerplate, browsersync, es2015, es6, gulp, jade, pug, scaffolding, stylus, svg-icons, svg-sprites
• Language: JavaScript
• Homepage:
• Size: 436 KB
• Stars: 70
• Watchers: 4
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


Mantis Starter

==============

> A modern kick-starter for front-end development packed with well-chosen tools

Get started

-----------

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

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

```shell

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

```

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

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

- Enter the folder: `cd my-project`

- Install Node dependencies: `yarn` or `npm install`

But I recommend you to install the easiest way.

Running

-------

You can run the app locally by running these following commands:

### Available Gulp commands

#### Default - `yarn start` or `npm start`

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

#### Build - `yarn run build` or `npm run build`

Run this command to only compile files

#### Clean - `yarn run clean` or `npm run clean`

Run this command to delete the `public/` folder (same as `rm -rf public`)

Structure

---------

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

```

gulpfile.babel.js/

├── tasks/

│   └── *.js

├── index.js

└── paths.js

node_modules/

src/

├── copy/

│   ├── fonts/

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

│   ├── **/*

├── css/

│   ├── components/

│   │   └── *.styl

│   ├── core/

│   │   └── *.styl

│   └── style.styl

├── html/

│   ├── components/

│   │   └── *.pug

│   ├── includes/

│   │   └── *.pug

│   ├── layouts/

│   │   └── *.pug

│   └── index.pug

├── img/

│   ├── backgrounds/

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

│   ├── favicons/

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

│   ├── sprite/

│   │   └── *.svg

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

├── js/

│   ├── app/

│   │   ├── index.js

│   │   └── *.js

│   ├── modules/

│   │   └── *.js

│   └── app.js

.babelrc

.editorconfig

.env

.eslintrc

.gitattributes

.gitignore

.pug-lintrc

.stylintrc

content.json

install.sh

logo.png

logo.svg

package.json

README.md

```

License

-------

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

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