https://github.com/hesiod3c/examples
(in development) examples
https://github.com/hesiod3c/examples
angular react vue
Last synced: about 2 months ago
JSON representation
(in development) examples
- Host: GitHub
- URL: https://github.com/hesiod3c/examples
- Owner: hesiod3c
- Created: 2017-04-06T14:51:01.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T01:07:24.000Z (over 3 years ago)
- Last Synced: 2025-10-09T03:08:09.402Z (9 months ago)
- Topics: angular, react, vue
- Language: JavaScript
- Homepage:
- Size: 10.3 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Descco UI
[](http://hemersonvianna.mit-license.org/)
[](https://github.com/hesiod3c/examples/issues)
* (in development)
**important!** Always see the documentation
## Prerequisites
- [Node >= v6.9.2](https://nodejs.org/en/)
- NPM >= v3.10.8
- [Yarn >= v0.21.3](https://yarnpkg.com/en/docs/install#linux-tab) or `npm install -g yarn`
### Prerequisites for development
- **Editor Config**:
- [Atom](https://github.com/sindresorhus/atom-editorconfig#readme)
- [Sublime text](https://github.com/sindresorhus/editorconfig-sublime#readme)
- [Brackets](https://github.com/kidwm/brackets-editorconfig/)
- [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
- [Vim](https://github.com/editorconfig/editorconfig-vim#readme)
- **CSS Comb**:
- [Atom](https://atom.io/packages/atom-csscomb)
- [Sublime text](https://packagecontrol.io/packages/CSScomb)
- [Brackets](https://github.com/i-akhmadullin/brackets-csscomb)
- [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=mrmlnc.vscode-csscomb)
- [Vim](https://github.com/csscomb/vim-csscomb)
- **Sass Lint**:
- [Atom](https://atom.io/packages/linter-sass-lint)
- [Sublime Text](https://github.com/skovhus/SublimeLinter-contrib-sass-lint)
- [Brackets](https://github.com/petetnt/brackets-sass-lint)
- [IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm](https://github.com/idok/sass-lint-plugin)
- [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=glen-84.sass-lint)
- [Vim](https://github.com/gcorne/vim-sass-lint)
- **ESLint**:
- [Atom](https://atom.io/packages/linter-eslint)
- [Sublime text](https://github.com/roadhump/SublimeLinter-eslint)
- [IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm](http://plugins.jetbrains.com/plugin/7494)
- [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [Vim](https://github.com/scrooloose/syntastic/tree/master/syntax_checkers/javascript)
## In the your project
```bash
npm install --save-dev @descco/ui
```
```bash
// package.json
"devDependencies": {
"@descco/ui": "vX.X.X"
}
```
```bash
// 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
```bash
yarn // or yarn install
```
## Usage
## UI components (storybook)
```bash
yarn storybook
// http://localhost:9000
```
## Lint
```bash
yarn lint
//[Rules in ESLint](http://eslint.org/docs/rules/)
```
## Tests
```bash
yarn test
```
## Release
```bash
npm install -g release-it
```
### Usage
Current release: v1.0.0-beta.4
Command:
```bash
release-it v1.0.0-beta.5
```
Questions and answers
**Release source repo**
```sh
- ? 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
```bash
./helpers/component/create.sh component-name path
```
```sh
└── 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
```
```bash
./helpers/component/create-with-redux.sh component-name path
```
```sh
└── 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](./docs/manual/01-git-flow.md)
2. [Commits](./docs/manual/02-commits.md)
3. [Architecture](./docs/manual/03-architecture.md)
4. [Dependencies](./docs/manual/04-dependencies.md)
5. [Technologies](./docs/manual/05-technologies.md)
6. [Identation (code style)](./docs/manual/06-identation-code-style.md)
7. [CSS (code style)](./docs/manual/07-css-code-style.md)
8. [Javascript (code style)](./docs/manual/08-javascript-code-style.md)
## 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](https://github.com/hesiod3c/examples/releases) for detailed changelog.
## License
[MIT license](http://hemersonvianna.mit-license.org/) © Hemerson Vianna
**[⬆ back to the top](#prerequisites)**