Hayden 92cf97e401
Feature/shopping lists second try (#927)
* generate types

* use generated types

* ui updates

* init button link for common styles

* add links

* setup label views

* add delete confirmation

* reset when not saved

* link label to foods and auto set when adding to shopping list

* generate types

* use inheritence to manage exception handling

* fix schema generation and add test for open_api generation

* add header to api docs

* move list consilidation to service

* split list and list items controller

* shopping list/list item tests - PARTIAL

* enable recipe add/remove in shopping lists

* generate types

* linting

* init global utility components

* update types and add list item api

* fix import cycle and database error

* add container and border classes

* new recipe list component

* fix tests

* breakout item editor

* refactor item editor

* update bulk actions

* update input / color contrast

* type generation

* refactor controller dependencies

* include food/unit editor

* remove console.logs

* fix and update type generation

* fix incorrect type for column

* fix postgres error

* fix delete by variable

* auto remove refs

* fix typo
2022-01-16 15:24:24 -09:00
..

Components Folder Guide

Domain Components

Domain Components are specific to the domain or section of a website. For example if you have an admin page and a user page that have specific, unshared elements. These can be placed in the Domain/Admin folder.

Rules

  • Components should be prefixed with their domain name
    • Examples: AdminDashboard, AdminSettings, UserProfile

Global Components

This folder is for widely reused components that provide little functionality and are primarily used for styling or consistency. Primary examples are Card and Button components.

Rules

  • Global components cannot container a subfolder to be globally imported
  • All elements should start with the 'Base' Prefix
    • Examples: BaseButton, BaseCard, BaseTitleSection

Layout Components

The layout folder is for reusable components that are specifically only used in the layouts for the Nuxt Application. They may take props or may not. They should be larger layout style components that don't have wide the ability to be widely reused in the application.

Rules:

  • Layout folder should not have a subfolder
  • If they take props they should start with a 'App' Prefix.
    • Examples: AppSidebar, AppHeader, AppFooter.
  • If they do not they should begin with the 'The' prefix
    • Examples: TheSidebar, TheHeader, TheFooter.

Page Components

The Page folder is dedicated to 'single-use' component to break up large amounts on content in the pages themselves. A good examples of this is breaking your landing page into separate sections to make it more readable and less monolithic. Page components typically consume other components.

Rules:

  • These are last resort components. Only to be used when the page becomes unmanageable.
  • Page components should be prefixed with their page name
    • Examples: HomeAbout, HomeContact, ClientProfile