From 2feec98479c808414104e37746369bceafa3a0b0 Mon Sep 17 00:00:00 2001 From: Angel Beltran Date: Sun, 28 Dec 2025 14:39:12 -0700 Subject: [PATCH] README.md: added app constraints section --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c6a1f2..e9053d2 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,23 @@ - [ ] Drop in a good logger +## Constraints + +- [ ] Etsy + - [ ] API Licensed Uses and Restrictions: + - [ ] Link directly back to the product information and/or image Content on Etsy, where the Application utilizes product information and/or images. + - [ ] Provide a prominently displayed email address on Your Application for third parties to contact You with any questions or issues. You shall respond to such inquiries in a timely manner. + - [ ] Use commercially reasonable efforts to provide a terms of service and privacy policy in a visible location on your Application. + - [ ] Display item Content or product information and/or images which is more than six (6) hours older than such information is on the Website, and other Etsy Content cannot be more than twenty-four (24) hours older than such Content on the Website. + - [ ] Use the API in a manner that exceeds reasonable request volume or constitutes excessive or abusive usage. Users are allocated by default, 10,000 calls per day. + - [ ] You shall not use or alter any text, logos, Etsy's Trademarks, Etsy's signature colors, Etsy's layout, or a confusingly similar layout to Etsy's layout in such a way which may suggest endorsement or affiliation by Etsy. + - [ ] Any use of the Etsy logo or Etsy's Trademarks must be used in its entirety and must not be altered or used in a misleading way. + - [ ] You shall not use a mark which is confusingly similar to Etsy's Trademarks. + - [ ] Any use of the Etsy logo or Etsy's Trademarks in Your Application shall be less prominent than the logo or mark that primarily describes the Application and Your use of the Etsy logo shall not imply any endorsement or affiliation by Etsy. + - [ ] You may publicize, issue press or blog releases of Your Application only if You state that it was created using the Etsy API and that You in no way imply that Your Application is endorsed or certified by Etsy. + - [ ] You must place or display the following notice prominently on Your Application: + "The term 'Etsy' is a trademark of Etsy, Inc. This application uses the Etsy API but is not endorsed or certified by Etsy, Inc." + - [ ] Immediately report any security deficiencies You discover to Etsy by emailing developer@etsy.com. Looking to follow the [CQRS](https://martinfowler.com/bliki/CQRS.html) pattern. @@ -21,7 +38,7 @@ The database will follow the [event sourcing](https://martinfowler.com/eaaDev/Ev All events (or commands) will be stored in a respective event series, and all database reads will be from views that are projections, reductions, aggregations of those event series. -## Application/directory structure +## Application/directory structure - /internal - /site: website - /webhooks: webhooks for platform events @@ -34,6 +51,10 @@ All events (or commands) will be stored in a respective event series, and all da ![Application structure](./diagrams/application_structure.svg) +## Website heirarchy + +- /site + ## Architectural and Software Diagrams