feat: Add basic todo-list demo (#1)

* New react-app for todo list demo

* Add Redux example project

* Refactor todo-list demo to use hooks

* Update eslint config to fix build

.eslintrc.js

@@ -10,5 +10,6 @@ module.exports = {
     'prettier/@typescript-eslint',
     'plugin:prettier/recommended',
   ],
-  ignorePatterns: ['dist/', 'coverage/', 'node_modules/'],
+
+  ignorePatterns: ['demos/', 'dist/', 'coverage/', 'node_modules/'],
 };

README.md

@@ -11,7 +11,7 @@ Create Recoil atoms and selectors from your existing actions, reducers, and sele
 
 ## Motivation
 
-Migrating from [Redux](https://redux.js.org/) to [Recoil](https://recoiljs.org/) requires migrating a lot of code.
+Migrating from [Redux](https://redux.js.org/) to [Recoil](https://recoiljs.org/) can be a lot of work.
 
 This library contains utilities which take in your existing Redux-oriented functions and return Recoil state.
 The goal is to try things out with Recoil without having to migrate your entire codebase first.
@@ -33,20 +33,18 @@ import { atomFromReduxState } from 'redux-to-recoil';
 import { myActionCreator, myReducer, mySelector } from 'my-existing-code';
 
 // `atomFromReduxState` replaces Recoil's `atom()` constructor
-const todoAtom = atomFromReduxState('.todos'); // wraps state.todos
+const todoListAtom = atomFromReduxState('.todos'); // wraps state.todos
 
 const todoCountSelector = selector({
-  key: 'todoCountSelector',
-  get: ({ get }) => get(todoAtom).length,
+  key: 'todoCount',
+  get: ({ get }) => get(todoList).length,
 });
 
 // Inside your component, use the atoms and selectors as normal
-const [todos, setTodos] = useRecoilState(todoAtom);
+const [todoList, setTodoList] = useRecoilState(todoListAtom);
 const todoCount = useRecoilState(todoCountSelector);
 
-// And continue to use Redux, too
-const todoCount = useSelector(myExistingSelector);
-<button onClick={() => dispatch(addTodo())}>
+// All Redux middleware and tools still work
 ```
 
 ```typescript jsx

demos/todo-list/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

demos/todo-list/README.md

@@ -0,0 +1,8 @@
+## Todo List demo
+
+This project takes the ["Todo List" example from Redux](https://redux.js.org/basics/example) and wraps the Redux state
+in `atomFromReduxState` so that it can be interacted with via Recoil.
+
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+[See the original readme here](./create-react-app.md).

demos/todo-list/create-react-app.md

@@ -0,0 +1,68 @@
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `yarn start`
+
+Runs the app in the development mode.<br />
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+The page will reload if you make edits.<br />
+You will also see any lint errors in the console.
+
+### `yarn test`
+
+Launches the test runner in the interactive watch mode.<br />
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `yarn build`
+
+Builds the app for production to the `build` folder.<br />
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br />
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `yarn eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).
+
+### Code Splitting
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
+
+### Analyzing the Bundle Size
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
+
+### Making a Progressive Web App
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
+
+### Advanced Configuration
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
+
+### Deployment
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
+
+### `yarn build` fails to minify
+
+This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

demos/todo-list/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "todo-list",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@testing-library/jest-dom": "^4.2.4",
+    "@testing-library/react": "^9.3.2",
+    "@testing-library/user-event": "^7.1.2",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
+    "react-redux": "^7.2.0",
+    "react-scripts": "3.4.1",
+    "redux": "^4.0.5",
+    "reselect": "^4.0.0"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject",
+    "lint": "eslint \"src/**/*.{js,jsx,json,ts,tsx}\""
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": "react-app"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}

demos/todo-list/public/index.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <title>Todo List demo</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

demos/todo-list/src/App.jsx

@@ -0,0 +1,22 @@
+import React from 'react';
+
+import { VisibilityFilters } from './actions';
+import AddTodo from './components/AddTodo';
+import FilterLink from './components/FilterLink';
+import VisibleTodoList from './components/VisibleTodoList';
+
+const App = () => (
+  <div>
+    <AddTodo />
+    <VisibleTodoList />
+
+    <div>
+      <span>Show: </span>
+      <FilterLink filter={VisibilityFilters.SHOW_ALL}>All</FilterLink>
+      <FilterLink filter={VisibilityFilters.SHOW_ACTIVE}>Active</FilterLink>
+      <FilterLink filter={VisibilityFilters.SHOW_COMPLETED}>Completed</FilterLink>
+    </div>
+  </div>
+);
+
+export default App;

demos/todo-list/src/actions/index.js

@@ -0,0 +1,23 @@
+let nextTodoId = 0;
+
+export const addTodo = (text) => ({
+  type: 'ADD_TODO',
+  id: nextTodoId++,
+  text,
+});
+
+export const setVisibilityFilter = (filter) => ({
+  type: 'SET_VISIBILITY_FILTER',
+  filter,
+});
+
+export const toggleTodo = (id) => ({
+  type: 'TOGGLE_TODO',
+  id,
+});
+
+export const VisibilityFilters = {
+  SHOW_ALL: 'SHOW_ALL',
+  SHOW_COMPLETED: 'SHOW_COMPLETED',
+  SHOW_ACTIVE: 'SHOW_ACTIVE',
+};

demos/todo-list/src/components/AddTodo.jsx

@@ -0,0 +1,30 @@
+import React, { useState } from 'react';
+import { connect, useDispatch } from 'react-redux';
+
+import { addTodo } from '../actions';
+
+const AddTodo = () => {
+  const dispatch = useDispatch();
+
+  const [inputValue, setInputValue] = useState('');
+
+  return (
+    <div>
+      <form
+        onSubmit={(e) => {
+          e.preventDefault();
+          const trimmedValue = inputValue.trim();
+          if (trimmedValue) {
+            dispatch(addTodo(trimmedValue));
+            setInputValue('');
+          }
+        }}
+      >
+        <input value={inputValue} onChange={(e) => setInputValue(e.target.value)} />
+        <button type="submit">Add Todo</button>
+      </form>
+    </div>
+  );
+};
+
+export default connect()(AddTodo);

demos/todo-list/src/components/FilterLink.jsx

@@ -0,0 +1,33 @@
+import PropTypes from 'prop-types';
+import React from 'react';
+import { useDispatch, useSelector } from 'react-redux';
+
+import { setVisibilityFilter, VisibilityFilters } from '../actions';
+import visibilityFilterSelector from '../selectors/visibilityFilterSelector';
+
+const FilterLink = (props) => {
+  const { children, filter } = props;
+  const dispatch = useDispatch();
+
+  const currentVisibilityFilter = useSelector(visibilityFilterSelector);
+  const isActive = filter === currentVisibilityFilter;
+
+  return (
+    <button
+      onClick={() => dispatch(setVisibilityFilter(filter))}
+      disabled={isActive}
+      style={{
+        marginLeft: '4px',
+      }}
+    >
+      {children}
+    </button>
+  );
+};
+
+FilterLink.propTypes = {
+  children: PropTypes.node.isRequired,
+  filter: PropTypes.oneOf(Object.values(VisibilityFilters)),
+};
+
+export default FilterLink;

demos/todo-list/src/components/Todo.jsx

@@ -0,0 +1,21 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+
+const Todo = ({ onClick, completed, text }) => (
+  <li
+    onClick={onClick}
+    style={{
+      textDecoration: completed ? 'line-through' : 'none',
+    }}
+  >
+    {text}
+  </li>
+);
+
+Todo.propTypes = {
+  onClick: PropTypes.func.isRequired,
+  completed: PropTypes.bool.isRequired,
+  text: PropTypes.string.isRequired,
+};
+
+export default Todo;

demos/todo-list/src/components/VisibleTodoList.jsx

@@ -0,0 +1,22 @@
+import React from 'react';
+import { useDispatch, useSelector } from 'react-redux';
+
+import { toggleTodo } from '../actions';
+import visibleTodosSelector from '../selectors/visibleTodosSelector';
+import Todo from './Todo';
+
+const VisibleTodoList = (props) => {
+  const dispatch = useDispatch();
+
+  const todos = useSelector(visibleTodosSelector);
+
+  return (
+    <ul>
+      {todos.map((todo) => (
+        <Todo key={todo.id} {...todo} onClick={() => dispatch(toggleTodo(todo.id))} />
+      ))}
+    </ul>
+  );
+};
+
+export default VisibleTodoList;

demos/todo-list/src/index.js

@@ -0,0 +1,18 @@
+import React from 'react';
+import { render } from 'react-dom';
+import { Provider } from 'react-redux';
+import { createStore } from 'redux';
+
+import rootReducer from './reducers';
+import App from './App';
+
+const store = createStore(rootReducer);
+
+render(
+  <React.StrictMode>
+    <Provider store={store}>
+      <App />
+    </Provider>
+  </React.StrictMode>,
+  document.getElementById('root'),
+);

demos/todo-list/src/reducers/index.js

@@ -0,0 +1,8 @@
+import { combineReducers } from 'redux';
+import todos from './todos';
+import visibilityFilter from './visibilityFilter';
+
+export default combineReducers({
+  todos,
+  visibilityFilter,
+});