Descco UI

• (in development)

important! Always see the documentation

Prerequisites

• Node >= v6.9.2
• NPM >= v3.10.8
• Yarn >= v0.21.3 or npm install -g yarn

Prerequisites for development

• Editor Config:
  • Atom
  • Sublime text
  • Brackets
  • Visual Studio Code
  • Vim
• CSS Comb:
  • Atom
  • Sublime text
  • Brackets
  • Visual Studio Code
  • Vim
• Sass Lint:
  • Atom
  • Sublime Text
  • Brackets
  • IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm
  • Visual Studio Code
  • Vim
• ESLint:
  • Atom
  • Sublime text
  • IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm
  • Visual Studio Code
  • Vim

In the your project

npm install --save-dev @descco/ui

// package.json
"devDependencies": {
  "@descco/ui": "vX.X.X"
}

// import the CSS

// ex: layout.js
import '[node_modules path]/@descco/ui/dist/ui.min.css';

// component.js
import { Alert } from '@descco/ui';

// webpack
{
  test: /\.scss$/,
  loader: 'style!css?modules=1&importLoaders=1&localIdentName=[name]_[local]_[hash:base64:5]!postcss!sass?sourceMap',
  include: path.resolve(__dirname, '../../source'),
  exclude: path.resolve(__dirname, "../../node_modules")
},
{
  test: /\.css/,
  loader: 'style!css',
  include: path.resolve(__dirname, "../../node_modules/@descco/ui/dist/")
}

Install

yarn // or yarn install

Usage

UI components (storybook)

yarn storybook
// http://localhost:9000

Lint

yarn lint
//[Rules in ESLint](http://eslint.org/docs/rules/)

Tests

yarn test

Release

 npm install -g release-it

Usage

Current release: v1.0.0-beta.4

Command:

release-it v1.0.0-beta.5

Questions and answers

Release source repo

- ? Show updated files? `Yes`
- M  package.json

- ? Commit (Release v1.0.0-beta.5)? `Yes`
- ? Tag (v1.0.0-beta.5)? `Yes`
- ? Push? `Yes`
- ? Publish "iron-fist" to npm? `No`

CLI

Creating file structure for the component

./helpers/component/create.sh component-name path

└── component-name
    ├── component-name/index.js
    ├── component-name/component-name-component.js
    ├── component-name/component-name.scss
    ├── component-name/component-name.story.js
    └── component-name/component-name.test.js

./helpers/component/create-with-redux.sh component-name path

└── component-name
    ├── component-name/index.js
    ├── component-name/component-name-actions.js
    ├── component-name/component-name-component.js
    ├── component-name/component-name-constants.js
    ├── component-name/component-name-container.js
    ├── component-name/component-name-reducer.js
    ├── component-name/component-name.scss
    ├── component-name/component-name.story.js
    └── component-name/component-name.test.js

Manual

1. Git Flow
2. Commits
3. Architecture
4. Dependencies
5. Technologies
6. Identation (code style)
7. CSS (code style)
8. Javascript (code style)

Contributing

• Fork it!
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -m 'Add some feature'
• Push to the branch: git push origin my-new-feature
• Submit a pull request

Log

Check Releases for detailed changelog.

License

MIT license © Hemerson Vianna

⬆ back to the top