Code Monkey home page Code Monkey logo

react-todo's Introduction

React todo component

A react todo component is created using material UI

image

Storybook

https://upnotes-io.github.io/react-todo/

Installation

// with npm
npm i react-todo-component

// with yarn
yarn add react-todo-component

Testing

yarn storybook

Usage

Here is a quick example to get you started, it's all you need:

import React from 'react';
import ReactDOM from 'react-dom';
import {Todo} from 'react-todo-component';

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

Contribution guide

If you're reading this, you're awesome! Thank you for helping us.

  • Clone git repository on your local git clone [email protected]:upnotes-io/react-todo.git
  • Run yarn install to install dependencies.
  • We are using storybook. Just run yarn run storybook to test on local.
  • Pick a issue and comment you are working on it.
  • Create your feature branch, do changes and create pull request.

Step to release the npm module

  1. Create a new account in npm. https://www.npmjs.com/signup
  2. Create a new access token and select publish as a type https://www.npmjs.com/settings/upnotes/tokens
  3. Add secret to your repo or organization as NPM_TOKEN https://github.com/organizations/upnotes-io/settings/secrets/actions/new
  4. Create a new tag and use that tag to create the release. Creating a new release will trigger the workflow.

Publishing to github pages:

Adding deploy keys to your repo:

  1. https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-
  2. https://docs.github.com/en/developers/overview/managing-deploy-keys#setup-2

react-todo's People

Contributors

bhujoshi avatar kamalkishor1991 avatar prateek3255 avatar gkasoff avatar ravencolevol avatar jisundr avatar serickson67 avatar avinier avatar harshithasivalingala avatar anasmansy avatar curis-lab avatar param-singh avatar pranesh239 avatar shahanahmed86 avatar sukhacoder02 avatar

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.