Skip to content
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

Incorporating relations in our examples #1358

Closed
5 tasks
dhmlau opened this issue May 24, 2018 · 3 comments
Closed
5 tasks

Incorporating relations in our examples #1358

dhmlau opened this issue May 24, 2018 · 3 comments
Assignees

Comments

@dhmlau
Copy link
Member

dhmlau commented May 24, 2018

Description / Steps to reproduce / Feature proposal

Incorporating relations in our examples, either create new example or use existing ones (e.g. todo example).

Acceptance Criteria

The example application should:

  • Create another todo intermediate example(a new example package)

  • demonstrate defining and configuring a hasMany relation, and calling related repository CRUD APIs from controller methods

  • have the necessary unit and acceptance tests

  • have proper naming convention for the controller method paths / API endpoints (a good read at https://medium.com/@factoryhr/how-to-build-a-good-api-relationships-and-endpoints-8b07aa37097c)

  • Docs and tutorials that show users scaffold the new example package step by step.
    Note:

  • List/User hasMany Todos

    • owner decides which use case makes more sense
  • Authentication is not in scope of this story.

  • bonus: figure out a way that don't duplicate code from todo example.

See Reporting Issues for more tips on writing good issues

@dhmlau
Copy link
Member Author

dhmlau commented May 30, 2018

In discussion with @b-admike and @shimks, there are few options on how to add relations in our examples:
Option 1: Use todo example

  • General idea: todo list has todo's
  • Pros: effort will be smaller because we will be adding models instead of creating a new app
  • Cons: it might be hard for our users to follow if one example serves too many purpose

Option 2: Recreate CoffeeShop example from LB3

  • General idea: create a trimmed down version of CoffeeShop that serves the purpose for showing hasMany relation. When we have more relations added, this would be the example to add.
  • Pros: this can be a dedicated example if we need to add more relations later. Also, we can use this as a reference on what would be the differences vs LB3

@b-admike
Copy link
Contributor

@dhmlau I've added some acceptance criteria, but I think we should discuss what type of app we would like to create before we estimate this task. Thoughts? We have a good starting point with the options you provided and I personally would like to go with Option 2, because I think creating a new app would not be daunting given the examples we already have in place.

@dhmlau
Copy link
Member Author

dhmlau commented Jul 20, 2018

closing as done.

@dhmlau dhmlau closed this as completed Jul 20, 2018
@shimks shimks added this to the July Milestone milestone Jul 31, 2018
@bajtos bajtos added the p1 label Aug 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

8 participants