A solution to build modern web applications with zero initial configuration.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.tmp
dist
gulp
src
tests
.babelrc
.browserslistrc
.editorconfig
.eslintrc.js
.gitattributes
.gitignore
.sass-lint.yml
.travis.yml
LICENSE
README.md
codecept.conf.js
gulpfile.js
package.json
yarn.lock

README.md

FElicious - Front-End Starter Kit

Build Status Codacy Badge Coverage Status

This is a Front-End starter kit with Browserify, PostCSS, BrowserSync and more. A solution to build modern web applications with zero initial configuration.

https://github.com/jrobinsonc/felicious

Features

Includes:

Requirements

Usage

  1. First of all, install dependencies:

    yarn install

    NOTE: If yarn install is giving errors, try deleting the file yarn.lock and run yarn install again.

  2. Then, to start development run:

    yarn start

    This will build the project and watch for changes running BrowserSync to reload your browser.

  3. To build for production:

    yarn build

Advanced usage

There are specific tasks you can use to build particular assets, for example, you can compress images running gulp images. Below you can see the list of available tasks:

NOTE: You must have Gulp globally installed to use these tasks.

Task Details
styles Transpile CSS
scripts Transpile JS
images Compress images
sprites Generates sprites
views Generate views
copy Copy files from the root (like favicon.ico) to dist/

Dev mode

If you need to run any of this tasks in DEV mode, you have to append --dev, for example, to transpile JavaScript without compress the result use gulp scripts --dev. Also, you can build the entire project using gulp build --dev.

Questions

If you have any questions, please feel free to ask through new issue.

License

Licensed under the MIT licence.