agrotis-io / vraw

Vraw is a implementation of react stateless components that can be used as a npm package in your projects.
MIT License
3 stars 0 forks source link

vraw

latest release travis ci build status percentage of code coverage by tests minimum node version code style: prettier commitizen friendly semantic release

🌱 Vraw is a implementation of react stateless components that can be used as a npm package in your projects.

Vraw Logomark with text "vraw" under the symbol

Usage

using npm:

$ npm install vraw --save

in code:

import React, { Component } from "react";
// importing Clock component
import { Clock } from "vraw";

class App extends Component {
  render() {
    return (
      // using Clock component
      <Clock msg="It works!" date={new Date()} />
    );
  }
}

export default App;

Motivation

Components are cool! We should use them everywhere. So, you expent time developing a lot of components and now you want to reuse them in another awesome project & all your projects need your components updated when a new feature is released (and you also need typechecking, tests, hot module replacement & all the good stuff).

Directory Structure

.
β”œβ”€β”€ src
|   └── components
|       └── MyComponent                 # Your component
|           β”œβ”€β”€ MyComponent.story.tsx   # Storybook of your component
|           β”œβ”€β”€ MyComponent.test.tsx    # Jest + Enzyme tests
|           β”œβ”€β”€ MyComponent.tsx         # Its JSX + Typescript file
|           β”œβ”€β”€ MyComponent.types.ts    # Types for props
|           └── index.ts                # Export Component
|       └── MyComponentX                # Another component X
|       └── MyComponentY                # Another component Y
|       └── MyComponentZ                # Another component Z
|       └── stories.tsx                 # Storybook config file
β”œβ”€β”€ dist
|    └── index.js                       # Exporting all Componentss

Features

Workflow

See presentation

Repository Workflow