Giter VIP home page Giter VIP logo

reaktus's Introduction

Reaktus

A component library for React, by Caktus Group ๐ŸŒต

๐Ÿš€ Use

  1. In your project, install reaktus using npm. react, react-dom and styled-components are peer dependencies.
npm i reaktus styled-components
  1. Then import:
import React, { useState } from 'react';
import ReactDOM from 'react-dom';
import { Button, POSITIVE, Input } from 'reaktus';

function MyForm() {
    const [email, setEmail] = useState('');
    const [password, setPassword] = useState('');

    return (
        <form>
            <Input type='email' value={email} onChange={e => setEmail(e.target.value)} label="Email" />
            <Input type='password' value={password} onChange={e => setPassword(e.target.value)} label="Password" />
            <Button variant={POSITIVE} onClick={() => alert('Not really logging in.')}>Log in!</Button>
        </form>
    )
}

ReactDOM.render(<MyForm />, document.getElementById('root'));

๐Ÿ”ฅ Develop

  1. Clone the repo:
git clone https://github.com/caktus/reaktus.git
  1. Install dependencies:
cd reaktus
npm i
  1. Start styleguidist server:
npm run start
  1. Open browser to localhost:6060

๐Ÿ”จ Test

  1. Clone the repo:
git clone https://github.com/caktus/reaktus.git
  1. Install dependencies:
cd reaktus
npm i
  1. Run tests:
npm run test

reaktus's People

Contributors

michael-caktus avatar mykltronn avatar

Stargazers

 avatar

Watchers

Sean Harrison avatar Tobias McNulty avatar Karen Tracey avatar Scott Morningstar avatar James Cloos avatar Jeremy Gibson avatar  avatar  avatar

Forkers

mykltronn

reaktus's Issues

improve development documentation

Development documentation should include more information, including but not limited to:

  1. Guidelines to follow
  2. Breakdown of project structure

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.