Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnnymo87/styleguide
Namely Styleguide
https://github.com/johnnymo87/styleguide
Last synced: 1 day ago
JSON representation
Namely Styleguide
- Host: GitHub
- URL: https://github.com/johnnymo87/styleguide
- Owner: johnnymo87
- Created: 2015-07-08T14:39:31.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2015-07-08T14:41:20.000Z (over 9 years ago)
- Last Synced: 2024-10-18T20:17:08.193Z (20 days ago)
- Language: JavaScript
- Homepage: http://www.namely.com
- Size: 1.98 MB
- Stars: 0
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Namely Styleguide (a.k.a Namely-UI / Namely-Bootstrap)
This is the styleguide app to document all the components and patterns for Namely.
Getting Started
---------------
1. Clone the repo and ```cd``` into the directory
2. Install dependencies
```shell
$ npm install
$ bower install
$ gem install scss-lint
```
3. Serve app
```shell
$ npm start
```
Packaging Files for Production
------------------------------
To create the main js and css file that are to be used by Namely and other properties:
```shell
$ npm run compile
```
This runs every component found in ```src/js/components/``` through Babel and places it in the ```dist/``` directory, including any sub-directories. Then it grabs the base namely-ui module from ```lib/namely-ui.js``` to run that through Babel and place it in ```dist/``` as well. Finally, it grabs ```lib/namely-ui.scss```, compiles it to css, autoprefixes, and minifies it before placing it in ```dist/```.