-
-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add about and getting started docs #2838
Draft
griest024
wants to merge
4
commits into
graycoreio:develop
Choose a base branch
from
griest024:docs/introduction
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+51
−0
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,24 @@ | ||
# About Daffodil | ||
|
||
Daffodil is a client-side framework for building ecommerce stores. It presents a standard set of interfaces with which the frontend application can interact along with a selection of drivers that communicate with the platform of choice. | ||
|
||
## Objectives | ||
Daffodil aims to: | ||
- Provide a strongly-typed set of libraries and component kit to simplify ecommerce store development | ||
- Ease migration between ecommerce platforms by decoupling frontend code from the current platform's API | ||
- Provide a collection of features a-la carte style such that no unused features are unnecessarily imported | ||
- Allow extension and customization such that business-specific features can be supported in a platform-agnostic way | ||
|
||
<!--- TODO: add link to longer motivations explanation ---> | ||
|
||
## Architecture | ||
The most common type of Daffodil package has a number of layers that can be visualized like so: | ||
```mermaid | ||
flowchart TD | ||
A[Routing] --> B[State] | ||
B --> C{Driver Interfaces} | ||
D[Platform Drivers] --> C | ||
C --> E[Models] | ||
``` | ||
Each of these layers exists as a subpackage of the corresponding feature module, e.g. `@daffodil/cart/state`. | ||
<!--- TODO: add link to longer architecture explanation ---> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,30 @@ | ||
# Getting Started | ||
## Installation | ||
Daffodil packages are provided a la carte. Each package provides a particular feature and must be installed separately. The following example demonstrates how to install the product package with `npm`. | ||
|
||
```sh | ||
npm install --save @daffodil/product | ||
``` | ||
|
||
## Usage | ||
The first step is to choose a driver that corresponds to the platform of choice. Daffodil provides lightweight in-memory API drivers to mock out a test platform for rapid frontend development. | ||
<!--- TODO: add link to in-memory explanation ---> | ||
Once a platform has been chosen, import the corresponding driver module: | ||
|
||
```ts | ||
import {DaffProductInMemoryDriverModule} from '@daffodil/product/driver/in-memory' | ||
|
||
@NgModule({ | ||
imports: [ | ||
DaffProductInMemoryDriverModule.forRoot() | ||
] | ||
}) | ||
class AppModule {} | ||
``` | ||
|
||
Interacting with a given platform through Daffodil can be done in a couple of ways. The simplest, and recommended, way is through state. | ||
|
||
### State | ||
Interaction with the platform is done by dispatching actions and reading data from facades. Daffodil state packages track the loading state of each operation and store the results and/or errors in redux state. | ||
|
||
<!--- TODO: add link to simple state example ---> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.