Merge pull request #66 from supabase/feature/todo-example

Feature/todo example

examples/todo/.gitignore

@@ -0,0 +1,25 @@
+# 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*
+
+.vercel

examples/todo/README.md

@@ -0,0 +1,51 @@
+## Warning
+
+This demo doesn't provide any form of client-side authentication so please don't use it in
+production unless you're ok with all your tasks being publicly available
+
+## Required env vars
+
+Make a `.env` in this folder with the following, 
+you can get these values from your project dashboard at [app.supabase.io](app.supabase.io):
+
+```bash
+REACT_APP_SUPABASE_URL=<your-supabase-url>
+REACT_APP_SUPABASE_KEY=<your-supabase-key>
+```
+
+## 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.

examples/todo/db/task_list_schema.sql

@@ -0,0 +1,14 @@
+CREATE TABLE lists (
+  uuid text,
+  id bigserial PRIMARY KEY,
+  inserted_at timestamp without time zone DEFAULT timezone('utc' :: text, now()) NOT NULL,
+  updated_at timestamp without time zone DEFAULT timezone('utc' :: text, now()) NOT NULL
+);
+CREATE TABLE tasks (
+  task_text text NOT NULL,
+  complete boolean DEFAULT false,
+  id bigserial PRIMARY KEY,
+  list_id bigint REFERENCES lists NOT NULL,
+  inserted_at timestamp without time zone DEFAULT timezone('utc' :: text, now()) NOT NULL,
+  updated_at timestamp without time zone DEFAULT timezone('utc' :: text, now()) NOT NULL
+);

examples/todo/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "todo",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@supabase/supabase-js": "^0.1.32",
+    "@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-router-dom": "^5.1.2",
+    "react-scripts": "3.4.1"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject",
+    "deploy": "react-scripts build && cd build && now --prod"
+  },
+  "eslintConfig": {
+    "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"
+    ]
+  }
+}

examples/todo/public/index.html

@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<base href="/" />
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Create and share task lists amongst friends and colleagues"
+    />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>Supabase Task List</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>

examples/todo/public/manifest.json

@@ -0,0 +1,15 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

examples/todo/public/robots.txt

@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:

examples/todo/src/Store.js

@@ -0,0 +1,97 @@
+import { useState, useEffect } from 'react'
+import { createClient } from '@supabase/supabase-js'
+
+const supabase = createClient(
+  process.env.REACT_APP_SUPABASE_URL,
+  process.env.REACT_APP_SUPABASE_KEY
+)
+
+export const useStore = (props) => {
+  const [list, setList] = useState(null)
+  const [tasks, setTasks] = useState([])
+  const [newTask, handleNewTask] = useState()
+  const [taskListener, setTaskListener] = useState(null)
+
+  useEffect(() => {
+    fetchList(props.uuid)
+      .then((response) => {
+        setList(response)
+        setTasks(response.tasks.sort((a, b) => a.id - b.id))
+      })
+      .catch(console.error)
+  }, [])
+
+  useEffect(() => {
+    const handleAsync = async () => {
+      if (newTask) {
+        // could be an update
+        let update = tasks.find((task, i) => {
+          if (task.id === newTask.id) {
+            tasks[i] = newTask
+            return true
+          }
+        })
+        if (update) {
+          setTasks([...tasks]) // update
+        } else {
+          setTasks(tasks.concat(newTask)) // new
+        }
+      }
+    }
+    handleAsync()
+  }, [newTask])
+
+  useEffect(() => {
+    if (!taskListener && list) {
+      setTaskListener(
+        supabase
+          .from(`tasks:list_id=eq.${list.id}`)
+          .on('INSERT', (payload) => handleNewTask(payload.new))
+          .on('UPDATE', (payload) => handleNewTask(payload.new))
+          .subscribe()
+      )
+    }
+  }, [list])
+
+  return { list, tasks, setTasks }
+}
+
+export const addTask = async (task_text, list_id) => {
+  try {
+    let { body } = await supabase.from('tasks').insert([{ task_text, list_id }])
+    return body
+  } catch (error) {
+    console.log('error', error)
+  }
+}
+
+export const updateTask = async (task_id, values) => {
+  try {
+    let { body } = await supabase.from('tasks').eq('id', task_id).update(values)
+    return body
+  } catch (error) {
+    console.log('error', error)
+  }
+}
+
+export const createList = async (uuid) => {
+  try {
+    let { body } = await supabase.from('lists').insert([{ uuid }])
+    return body[0]
+  } catch (error) {
+    console.log('error', error)
+  }
+}
+
+export const fetchList = async (list_uuid) => {
+  try {
+    let { body } = await supabase
+      .from('lists')
+      .eq('uuid', list_uuid)
+      .select(`*, tasks(*)`)
+      .single()
+    return body
+  } catch (error) {
+    console.log('error', error)
+  }
+}

examples/todo/src/TodoList.js

@@ -0,0 +1,65 @@
+import React, { useState } from 'react'
+import { Link } from 'react-router-dom'
+import { useStore, addTask, updateTask } from './Store'
+
+export const TodoList = (uuid) => {
+  const [newTaskText, setNewTaskText] = useState('')
+  const { tasks, setTasks, list } = useStore({ uuid })
+
+  return (
+    <div className="container">
+      <Link to="/">back</Link>
+      <h1 className="section">My Task List</h1>
+      <div className="section">
+        <label>Sharing url: </label>
+        <input type="text" readonly value={window.location.href} />
+      </div>
+      <div className={'field-row section'}>
+        <form
+          onSubmit={(e) => {
+            e.preventDefault()
+            setNewTaskText('')
+          }}
+        >
+          <input
+            id="newtask"
+            type="text"
+            value={newTaskText}
+            onChange={(e) => setNewTaskText(e.target.value)}
+          />
+          <button type="submit" onClick={() => addTask(newTaskText, list.id)}>
+            add task
+          </button>
+        </form>
+      </div>
+      <div className="section">
+        {tasks
+          ? tasks.map((task) => {
+              return (
+                <div key={task.id} className={'field-row'}>
+                  <input
+                    checked={task.complete ? true : ''}
+                    onChange={(e) => {
+                      tasks.find((t, i) => {
+                        if (t.id === task.id) {
+                          tasks[i].complete = !task.complete
+                          return true
+                        }
+                      })
+                      setTasks([...tasks])
+                      updateTask(task.id, { complete: e.target.checked })
+                    }}
+                    type="checkbox"
+                    id={`task-${task.id}`}
+                  ></input>
+                  <label htmlFor={`task-${task.id}`}>
+                    {task.complete ? <del>{task.task_text}</del> : task.task_text}
+                  </label>
+                </div>
+              )
+            })
+          : ''}
+      </div>
+    </div>
+  )
+}

examples/todo/src/index.css

@@ -0,0 +1,21 @@
+body {
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
+    'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
+    sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  background-color: rgb(250, 217, 246);
+}
+
+h1 {
+  margin-bottom: 0;
+}
+
+.container {
+  margin: 1em;
+}
+
+.section {
+  margin: 1em;
+}

examples/todo/src/index.js

@@ -0,0 +1,58 @@
+import React from 'react'
+import './index.css'
+import { BrowserRouter as Router, Route, Switch, useHistory } from 'react-router-dom'
+import { render } from 'react-dom'
+import { TodoList } from './TodoList'
+import * as serviceWorker from './serviceWorker'
+import { v4 as uuidv4 } from 'uuid'
+import { createList } from './Store'
+import queryString from 'query-string'
+
+const newList = async (history) => {
+  const list = await createList(uuidv4())
+  history.push(`/?uuid=${list.uuid}`)
+}
+
+const Home = (props) => {
+  const history = useHistory()
+  const uuid = queryString.parse(props.location.search).uuid
+
+  if (uuid) return TodoList(uuid)
+  else {
+    return (
+      <div className="container">
+        <div className="section">
+          <h1>Collaborative Task Lists</h1>
+          <small>
+            Powered by <a href="https://supabase.io">Supabase</a>
+          </small>
+        </div>
+        <div className="section">
+          <button
+            onClick={() => {
+              newList(history)
+            }}
+          >
+            new task list
+          </button>
+        </div>
+      </div>
+    )
+  }
+}
+
+render(
+  <div className="App">
+    <Router>
+      <Switch>
+        <Route exact path="/" component={Home} />
+      </Switch>
+    </Router>
+  </div>,
+  document.body
+)
+
+// If you want your app to work offline and load faster, you can change
+// unregister() to register() below. Note this comes with some pitfalls.
+// Learn more about service workers: https://bit.ly/CRA-PWA
+serviceWorker.unregister()

examples/todo/src/serviceWorker.js

@@ -0,0 +1,141 @@
+// This optional code is used to register a service worker.
+// register() is not called by default.
+
+// This lets the app load faster on subsequent visits in production, and gives
+// it offline capabilities. However, it also means that developers (and users)
+// will only see deployed updates on subsequent visits to a page, after all the
+// existing tabs open on the page have been closed, since previously cached
+// resources are updated in the background.
+
+// To learn more about the benefits of this model and instructions on how to
+// opt-in, read https://bit.ly/CRA-PWA
+
+const isLocalhost = Boolean(
+  window.location.hostname === 'localhost' ||
+    // [::1] is the IPv6 localhost address.
+    window.location.hostname === '[::1]' ||
+    // 127.0.0.0/8 are considered localhost for IPv4.
+    window.location.hostname.match(
+      /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
+    )
+);
+
+export function register(config) {
+  if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
+    // The URL constructor is available in all browsers that support SW.
+    const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
+    if (publicUrl.origin !== window.location.origin) {
+      // Our service worker won't work if PUBLIC_URL is on a different origin
+      // from what our page is served on. This might happen if a CDN is used to
+      // serve assets; see https://github.com/facebook/create-react-app/issues/2374
+      return;
+    }
+
+    window.addEventListener('load', () => {
+      const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
+
+      if (isLocalhost) {
+        // This is running on localhost. Let's check if a service worker still exists or not.
+        checkValidServiceWorker(swUrl, config);
+
+        // Add some additional logging to localhost, pointing developers to the
+        // service worker/PWA documentation.
+        navigator.serviceWorker.ready.then(() => {
+          console.log(
+            'This web app is being served cache-first by a service ' +
+              'worker. To learn more, visit https://bit.ly/CRA-PWA'
+          );
+        });
+      } else {
+        // Is not localhost. Just register service worker
+        registerValidSW(swUrl, config);
+      }
+    });
+  }
+}
+
+function registerValidSW(swUrl, config) {
+  navigator.serviceWorker
+    .register(swUrl)
+    .then(registration => {
+      registration.onupdatefound = () => {
+        const installingWorker = registration.installing;
+        if (installingWorker == null) {
+          return;
+        }
+        installingWorker.onstatechange = () => {
+          if (installingWorker.state === 'installed') {
+            if (navigator.serviceWorker.controller) {
+              // At this point, the updated precached content has been fetched,
+              // but the previous service worker will still serve the older
+              // content until all client tabs are closed.
+              console.log(
+                'New content is available and will be used when all ' +
+                  'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
+              );
+
+              // Execute callback
+              if (config && config.onUpdate) {
+                config.onUpdate(registration);
+              }
+            } else {
+              // At this point, everything has been precached.
+              // It's the perfect time to display a
+              // "Content is cached for offline use." message.
+              console.log('Content is cached for offline use.');
+
+              // Execute callback
+              if (config && config.onSuccess) {
+                config.onSuccess(registration);
+              }
+            }
+          }
+        };
+      };
+    })
+    .catch(error => {
+      console.error('Error during service worker registration:', error);
+    });
+}
+
+function checkValidServiceWorker(swUrl, config) {
+  // Check if the service worker can be found. If it can't reload the page.
+  fetch(swUrl, {
+    headers: { 'Service-Worker': 'script' },
+  })
+    .then(response => {
+      // Ensure service worker exists, and that we really are getting a JS file.
+      const contentType = response.headers.get('content-type');
+      if (
+        response.status === 404 ||
+        (contentType != null && contentType.indexOf('javascript') === -1)
+      ) {
+        // No service worker found. Probably a different app. Reload the page.
+        navigator.serviceWorker.ready.then(registration => {
+          registration.unregister().then(() => {
+            window.location.reload();
+          });
+        });
+      } else {
+        // Service worker found. Proceed as normal.
+        registerValidSW(swUrl, config);
+      }
+    })
+    .catch(() => {
+      console.log(
+        'No internet connection found. App is running in offline mode.'
+      );
+    });
+}
+
+export function unregister() {
+  if ('serviceWorker' in navigator) {
+    navigator.serviceWorker.ready
+      .then(registration => {
+        registration.unregister();
+      })
+      .catch(error => {
+        console.error(error.message);
+      });
+  }
+}