rlamorea / recipe-hub Goto Github PK

This requires:

• User object
• Sign up with a Google account
• Login with Google account
• Ability to log out

We are building this on React (front-end) and Node (back-end), so we need to get the basic server/front-end up and running.

Completed when we can get a Hello World page up and going.

We need a standard list of recipes. This should:

• Use recipe summaries
• Be paginated (pages of 10)

Ideally we want to be able to preview a recipe (rather than view it in editable form).

The selected tag display shows only selected tags for a recipe. It can be embedded in a recipe summary or details page.

• compact form (compressed grouping)
• expanded form (expanded grouping)
• embed compact form in recipe summary
• embed expanded form in recipe page (maybe toggle compact/expanded?)
• unit tests.

We want to be able to print an embedded google doc (in Preview mode ideally, barring that, in edit mode).

Create a Tags object

• Name of tag
• Parent of tag (nullable)
• Selectable (default true, false for non-selectable group headings)
• Full CRUD
• Deletion of parent means all children pointing to parent have parent replaced with deleted tag's parent.
• Unit tests

Fabricator is fine, but Storybook is better for React.

See here: https://storybook.js.org/

Build the API to search by tag matching

• Match all recipes that have one tag
• Match all recipes that have at least one tag
• Match all recipes that have all of a set of tags
• Match all recipes that do not have one tag
• Match all recipes that do not have at any of a set of tags.
• Unit tests

Find a way to do Google Docs API unit tests. This will almost certainly be done with emulation. Unclear if there is an existing library to do it or one needs to be built.

Integrate free text search into the recipe list

• Search box with delayed-action RESTful call
• Embed "reloading" mode into list display
• Update list results with returned search results
• Work for both adding and removing characters from search
• Work for pasting into search box
• Add "clear" action to search box
• Work for clear/group delete of all text in search box
• Work for group delete of block of text in search box
• Unit tests

Read a list of files from a specific folder (recipes) of the current user's Google Docs.

Provide the means to search recipes via Google text search.

• Extend Recipe List API to specify search
• Use search parameters to call Google text search
• Filter results to ensure match with known (DB) recipes
• Unit tests

Build a widget for displaying tags in groups, allowing selection/deselection of tags.

• Top level should be "header" groups (unselectable "tags")
• One group of "other" for all parentless tags.
• Subsequent levels should only show direct children of parent.
• If a parent tag is selected and has children, then show children to select.
• If parent tag is unselected, all selected children are automatically unselected as well.
• Widget should be an overlay that expands/contracts as needed.
• Unit tests.

It is unclear if we need to label the files we want to search to limit the search results, or just search the entire Docs and filter by what we know in the DB. Also if there is a way to limit the search to a specific folder, that would help a great deal.

The Recipe Summary display is used for list items (and possibly other places).

It provides the name of the recipe (linked to details) and other information to be added later.

Create a Google Document (recipe) directly via APIs.

We want to maintain a login to the account. Ideally this should be done by a Google token rather than a local JWT.

• See if we can auto log in via Google user token (if it exists)
• See if the Google token is available on the phone and for how long.

Build a testing infrastructure for the node server side. Prove that it works.

A page that displays full recipe details, which is:

• Name of the recipe
• Embedded view of recipe document
• Ability to live-edit the name of the recipe
• Ability to switch to edit view of the recipe in docs

The UI to select tags to search for.

• Select from (grouped) list of tags.
• Add/remove tags from search.
• Embed tags into search bar.
• Allow for deletion of tag in search bar.
• Unit tests

Prove that we can delete a Google Doc via API

Provide means to mix tag and free-text searching

• Use tags embedded in search box with text entered there
• Do both searches, intersect results
• Return by pages (tricky)
• Unit tests

We'll need a DB to store information.

The quickest and easiest to implement for our needs will be MongoDB, so we'll use that.

We will need:

• Installation and configuration of MongoDB
• Set up a simple object to link to the DB (Mongoose)
• Set up a unit test to prove it works (and we can simulate the DB)

Need REST-ful CRUD API for Recipes.

• Full List API (limited results possible to populate summaries)
• Paginated List API
• Read API (populate details)
• Update (name/title only)
• Delete - deletes the file
• Unit tests

Each recipe file needs an associated object in the DB.

• Wrapper to store recipe name (doc title) and doc file path and ID
• Update of name updates doc title as well
• Identify recipe files that don't exist in DB
• Identify document title changes by file ID and update DB
• Unit tests

Recipe object needs to have a list of assigned tags.

• Create - Add tags to recipe
• Update - Add or Remove tags from recipe
• Read - Get tags for recipe
• Unit tests

Show a Google Document embedded on a page.

Create a button (overriding MDL button) that adds a behavior to
put the button into an inactive mode with an embedded spinner
and "Saving" message.

I need to get eslint or jshint or whichever works best set up for the front (react) and back (node/express/feathers). This should work in WebStorm, in Hound, and via a command-line execution.

Each user configures the folder in Google Docs where their recipes can be found and will be stored.

Get the LSG in place -- chosen solution is Fabricator
https://fbrctr.github.io/

Build a client-side testing infrastructure, prove that it works in a simple case.