Skip to content

lotrekagency/lotrek-UI

Repository files navigation

Lotrek UI Logo

Lotrek UI is a collection of ready-to-use UI components and micro layouts written in simple HTML & CSS to help you build awesome stuff faster.

Each block is easy to customize, tested and responsive.

To check the demo/docs page please visit:

Table of contents

Using lotrek UI

Running the demo

lotrek-ui.css

Prerequisities

How to contribute

Built with

Copyright and license

TODO

Using lotrek UI

To use this collection of micro-layouts simply copy the HTML code inside <template> in the /components/category/name-of-block.vue file.

Remember to add the lotrek-ui.css stylesheet in your project, which is a very small CSS file (less than 3kb when compressed with GZIP). To do so, simply do the following:

yarn add lotrek-ui-css

Then add the CSS file, like this in your javascript file:

import 'lotrek-ui-css/build/lotrek-ui.css'

Running the demo

The Lotrek UI Kit has ready-to-use HTML blocks with some starter CSS (and JS when needed). Each block is written as a component which can be found in the /components/ path.

The demo page is localted in the Demo.vue component file: all you need to do is

yarn install

yarn dev

Now you should be able to view the demo page on http://localhost:3000/

If you wish to build for production, run:

yarn generate

/docs/ will have the production files and assets.

lotrek-ui.css

The CSS bundle file (lotrek-ui.css) to make the raw HTML blocks work is located at the /styles/build/ path.

To build this file (for publish purposes) simply do the following:

cd styles

yarn css

Prerequisities

Node, either npm or yarn.

rollup.js to build the css dist file.

How to contribute

To start contributing make your own branch such as feature/myblock starting from master. Then add blocks to the collection by making a vue component files in the /components/<category> folder. Styling is written in SCSS with BEM and mobile-first, so keep naming as clean and faithful to the methodology as possible. All the blocks style files can be found in in the /styles/blocks/<category> path, so when adding a new block add a new SCSS file here and remember to import it via main.scss. Once you're done with your work, submit a pull request.

Built with

NuxtJS, Vue, rollup.js and some good old HTML, CSS and JS. Resetting CSS with a slightly different version of normalize.css. PrismJS for code highlighting.

Copyright and license

lotrekagency/lotrek-UI is licensed under the MIT License

TODO

• Better demo page

• Better readme