ui-website

Usage

Run the following commands:

To clone the repository

git clone https://github.com/performanceArtist/ui-website.git

To install dependencies

npm install

To start the development server on port 5000(can be set in webpack.config)

npm start

Development build

npm run dev

Production build

npm run build

Eslint

npx eslint src

All code resides in src directory, except for config files. Build results go into dist directory.

src folders:

components - components used independently.
composite - composite components (they use pug mixins from the components folder).
partials - scss partials: layout css, mixins and variables(defaults.scss)
plugins - jQuery plugins that weren't installed through npm.
static - static files. Fonts, images, etc.
views - website pages

src files:

layout.pug - main layout file used in every page.
main.scss - contains imports for component/composite css.
styles.js - imports main.scss, as well as other common css files, such as font and plugin css.
scripts.js - exports js functions to work with ui(all call examples can be found in ui.js file).
favicons.js - loads favicons with file-loader.