shahanahmed86 / react-todo

A generic todo list componet for react. This is being used in an electron based app: https://upnotes.io

React todo component

A react todo component is created using material UI

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 [e-mail]: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