CSS Shortcut APP

Curso CSS ShortCut com Afonso Pacifer

Stack

• Task Runner: Gulp
• HTML Template Engine: Pug
• CSS Preprocessor: Stylus
• JS Transpiler: Babel

Run the project locally

1 - Prepare the environment:

$ npm install -g gulp-cli

2 - Clone the project and install the dependencies:

$ git clone https://github.com/JohnsonMauro/csshortcut-app.git
$ cd csshortcut-app
$ npm install

3 - Run static server and livereload:

$ gulp server

Folders Structure

  .
  ├── README.md
  ├── LICENSE.md
  ├── CONTRIBUTING.md
  ├── out/
  ├── src/
  |   ├── assets/
  |   |   ├── img/
  |   |   ├── scripts/
  |   |   |   └── script.js
  |   |   └── styles/
  |   |       ├── modules/
  |   |       └── style.styl
  |   ├── partials/
  |   |   ├── footer.pug
  |   |   └── header.pug
  |   ├── layouts/
  |   |   └── default.pug
  |   ├── projects.pug
  |   └── index.pug
  ├── gulpfile.js
  ├── package.json
  ├── projects.json
  ├── .editorconfig
  └── .gitignore

Automatic Tasks

• $ gulp build: Compile, concat and minify all files.
• $ gulp server: Watch the files to build and start a static server.
• $ gulp deploy: Deploy for gh-pages.

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our roadmap the next steps of the project ;)
Want to contribute? Follow these recommendations.

License

MIT License © Johnson Mauro