Contributing

Install

Download the repository to your environment using git clone of download option of github. The project use npm to controle the dependencies, and to install every dependency that the project requires, use this command:

$ npm install

Project structure

The project structure is:

src
  \- components       /* Components folder */
  \- fonts            /* Fonts folder */
  \- images           /* Images folder */
  \- js               /* Javascript sources folder */
  \- plugins          /* External sources folder */
  \- styles           /* Usefull styles folder */
  \- mixins.scss      /* Scss mixins collection */
  \- tuicss.scss      /* Compile entry file */
  \- variables.scss   /* All variables file */

The sources are present in the src folder. After change anyone, compile the project, and the compiled files will be created at dist folder. See compile session.

Compile

After install the project, you can compile the sources using this gulp command:

$ npm run build

Or use the shortcut: (This method needs the global gulp installed)

$ gulp

The dist folder will be cleaned, and the compiled files will be created in this folder.

New Features

To create new features to the project, you can't forget to import the created files in the src/tuicss.scss source. This is the entry source that will be used to compile the project.

Tools

I really recommend to use VSCode as the editor for the project, to be sure that the programming style will be kept.