Code Monkey home page Code Monkey logo

flux's Introduction

Flux

Flux is a set of tasks developed with Gulp to make your front-end workflow easier. These tasks involve the compilation of files written with Jade, Stylus and Coffeescript pre-processors integrated with different node packages in an organized folder structure.

Main tasks

Task Description
gulp clean Task to delete js, css, font and image files previously compiled.
gulp copy Task to copy fonts and images from the flux/frontend/ folder
gulp css Task to compile *.styl files to *.css.
gulp html Task to compile *.jade files to *.html.
gulp js Task to compile *.coffee files to *.js.
gulp sprites Task to generate a spritesheet from *.png image files.
gulp fonts Task to generate a css stylesheet from font files (*.eot, *.ttf, *.woff, *.svg).
gulp icons Tast to generate an icon font from *.svg images.
gulp watch Task to listen for any changes made in the *.coffee, *.styl, *.jade files and compile them automatically.
gulp bower Task to manage plugins installed with Bower.

Installation

Installing dependencies

Install npm and nodejs in linux

sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm

Install gulp globally

sudo npm install -g gulp

Install bower globally

sudo npm install -g bower

Working folder

All the front-end source files have to be added/modified in the frontend/ folder.

cd frontend/

Installing all the local dependencies for our project

Once you are in the frontend/ folder install all the dependencies located in the package.json file.

npm install

Note: If you need permissions add sudo at the beginning.

Run all the tasks

This command in the console will execute all the default tasks contained in the gulpfile.js file.

gulp

Note: You can also run gulp [name-of-the-task] individually.

Install libraries with bower

bower install

Run watchers

gulp watch

This task will automatically open a browser window with the default welcome page where you can see the frontendlabs logo.

Note:

  • We're using a server made with Express.js
  • The default route is: http://localhost:3000/
  • You can configure the url by editing the server.js file, which is located in /frontend/config/server.js

You can also access any project route. By default you can find a blank page in the following route http://localhost:3000/postulante/home/index

Documentation

flux's People

Contributors

jansanchez avatar wseng avatar victorjsv avatar jjhoncv avatar andru255 avatar pakgva avatar wilsson avatar anareyna avatar carloshs92 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.