From 4c862efd3448738c78ad653945b825a72d9fc052 Mon Sep 17 00:00:00 2001 From: devlinjunker Date: Wed, 15 Jul 2020 23:50:13 -0700 Subject: [PATCH 1/8] Add 0.1.md Basic outline of initial architecture document sections --- architecture/0.1.md | 59 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 architecture/0.1.md diff --git a/architecture/0.1.md b/architecture/0.1.md new file mode 100644 index 0000000..f7abde3 --- /dev/null +++ b/architecture/0.1.md @@ -0,0 +1,59 @@ +## Intro +This document should contain the initial application design... + +## Dependencies & Project Setup + +### Client +#### Initial Setup + +### Server +#### Initial Setup + +## Architecture + +### Client Side Application +#### Entry Point +#### Views +1. +2. +#### Workflows +1. +2. + +### Server (REST) API +#### Entry Point +#### Endpoints + +| Field | Value | +|------------------|--- | +| Endpoint | `/notes/all` | +| HTTP Method | `GET` | +| Headers | header-1: example
header-2: example-2 | + +**Request Body Example** +``` +{ + +} +``` +**Response Example** +``` + [{ + id: 1, + name: ‘Woven Fire’, + Category: 1, // or (2, 3) + location: ‘M61’, + craft: [‘Basketry’, ‘Pottery’], + crafters: [‘Deb Curtis`, ‘Rusty Hand’], + img_location: ‘/../..png’, + bio: ‘Yada yada’, + staff_special: false + }] + ``` + + + +### Communication Diagrams + +### Database Structure + From c34afa54ba04fd621571767e420f4a3f96398eaa Mon Sep 17 00:00:00 2001 From: devlinjunker Date: Thu, 16 Jul 2020 10:39:23 -0700 Subject: [PATCH 2/8] Update and rename architecture/0.1.md to docs/architecture.md --- architecture/0.1.md | 59 -------------------------------------- docs/architecture.md | 68 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 59 deletions(-) delete mode 100644 architecture/0.1.md create mode 100644 docs/architecture.md diff --git a/architecture/0.1.md b/architecture/0.1.md deleted file mode 100644 index f7abde3..0000000 --- a/architecture/0.1.md +++ /dev/null @@ -1,59 +0,0 @@ -## Intro -This document should contain the initial application design... - -## Dependencies & Project Setup - -### Client -#### Initial Setup - -### Server -#### Initial Setup - -## Architecture - -### Client Side Application -#### Entry Point -#### Views -1. -2. -#### Workflows -1. -2. - -### Server (REST) API -#### Entry Point -#### Endpoints - -| Field | Value | -|------------------|--- | -| Endpoint | `/notes/all` | -| HTTP Method | `GET` | -| Headers | header-1: example
header-2: example-2 | - -**Request Body Example** -``` -{ - -} -``` -**Response Example** -``` - [{ - id: 1, - name: ‘Woven Fire’, - Category: 1, // or (2, 3) - location: ‘M61’, - craft: [‘Basketry’, ‘Pottery’], - crafters: [‘Deb Curtis`, ‘Rusty Hand’], - img_location: ‘/../..png’, - bio: ‘Yada yada’, - staff_special: false - }] - ``` - - - -### Communication Diagrams - -### Database Structure - diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..8e21d1f --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,68 @@ +| | | +|-|-| +| Version | 0.1.0 | + +## Intro +This document should contain the application design and structure, detailing how the different components work together and how data is stored/retrieved. + +## Dependencies & Project Setup + +### Client +#### Initial Setup + +### Server +#### Initial Setup + +## Architecture + +### Client Side Application +#### Entry Point +#### Views +1. +2. +#### Workflows +1. +2. + +### Server (REST) API +#### Entry Point +#### Endpoints + + +1. List All Notes + + | | | + |-|-| + | Endpoint | `/notes/all` | + | HTTP Method | `GET` | + + + ##### Headers + | Field | Value | + |------------------|---| + | header-1 | example | + | header-2 | example-2 | + + ##### Request Body Example + ``` + { + + } + ``` + ##### Response Example + ``` + [{ + id: 1, + name: ‘Woven Fire’, + Category: 1, // (1 - 10) + img_location: ‘/../..png’, + bio: ‘Yada yada' + }] + ``` +2. Save Note + + +### Communication Diagrams + +### Database Structure + From 6da0274c4e430b96a321d8fb32ae870f68f4bd63 Mon Sep 17 00:00:00 2001 From: devlinjunker Date: Thu, 16 Jul 2020 10:42:58 -0700 Subject: [PATCH 3/8] Update architecture.md --- docs/architecture.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 8e21d1f..0733dcb 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -3,9 +3,10 @@ | Version | 0.1.0 | ## Intro -This document should contain the application design and structure, detailing how the different components work together and how data is stored/retrieved. +_This document should contain the application design and structure, detailing how the different components work together and how data is stored/retrieved._ ## Dependencies & Project Setup +_Describe the frameworks and libraries this project uses and how to set them up (Example sections provided)_ ### Client #### Initial Setup @@ -14,6 +15,7 @@ This document should contain the application design and structure, detailing how #### Initial Setup ## Architecture +_Describe how the components are structured and organized/where they retreive data from and how they display that (Example sections provided)_ ### Client Side Application #### Entry Point @@ -28,7 +30,6 @@ This document should contain the application design and structure, detailing how #### Entry Point #### Endpoints - 1. List All Notes | | | @@ -63,6 +64,7 @@ This document should contain the application design and structure, detailing how ### Communication Diagrams +_Describe the communcation protocol and when the different components talk to each other. You can also link to documents or include images that help to explain this_ ### Database Structure - +_Define the structure of the data stored in a each database/datastore. Diagrams are useful here too_ From 241e8bf6ec30b7ecff8de378e5002ebdc31fa0e2 Mon Sep 17 00:00:00 2001 From: devlinjunker Date: Thu, 16 Jul 2020 10:44:23 -0700 Subject: [PATCH 4/8] Update architecture.md --- docs/architecture.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index 0733dcb..ae3ff39 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,6 +1,6 @@ -| | | -|-|-| -| Version | 0.1.0 | +--- +Version: 0.1.0 +--- ## Intro _This document should contain the application design and structure, detailing how the different components work together and how data is stored/retrieved._ From 03813ef07d1a5a862774fa9381c6c99972a09154 Mon Sep 17 00:00:00 2001 From: devlinjunker Date: Thu, 16 Jul 2020 10:46:53 -0700 Subject: [PATCH 5/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73d244e..0e36a18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,9 @@ _Break down how each folder is used in the repo and how different code file type |-- workflows/ |---- (Github workflow .yaml files) |-- (other github specific files) +- docs/ +|-- architecture/ +|---- (Files helping to explain project structure) - (project config files and READMEs) ``` From a872bf8e2454434a78f11b85359a70f244d4af1c Mon Sep 17 00:00:00 2001 From: devlinjunker Date: Thu, 16 Jul 2020 10:53:28 -0700 Subject: [PATCH 6/8] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fc4e89b..470a34d 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,10 @@ _This section should try to quickly (1-3 paragraphs) explain how to setup the pr - [Code of Conduct](CODE_OF_CONDUCT.md) - [Contribute](CONTRIBUTING.md) +- [Architecture Doc](docs/architecture.md) - FAQ? - Wiki? -- Architecture Doc? -- How to understand the application from a developer point of view (webpage-> controllers -> services -> libraries) + ## Contributors From a8890fc8414f084c9cc2fb25968c991d5ff1e483 Mon Sep 17 00:00:00 2001 From: devlinjunker Date: Thu, 16 Jul 2020 11:03:45 -0700 Subject: [PATCH 7/8] Update architecture.md --- docs/architecture.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index ae3ff39..e184e2c 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -32,10 +32,9 @@ _Describe how the components are structured and organized/where they retreive da 1. List All Notes - | | | + | Method | Endpoint | |-|-| - | Endpoint | `/notes/all` | - | HTTP Method | `GET` | + | `GET` | `/notes/all` | ##### Headers From 65aea9a394e52c36d1f9558a43c07f539919245c Mon Sep 17 00:00:00 2001 From: devlinjunker Date: Fri, 17 Jul 2020 07:58:02 -0700 Subject: [PATCH 8/8] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e36a18..a6e0d79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,8 +30,8 @@ _Break down how each folder is used in the repo and how different code file type |---- (Github workflow .yaml files) |-- (other github specific files) - docs/ -|-- architecture/ -|---- (Files helping to explain project structure) +|-- architecture.md +|-- (Files helping to break down different sections of the project) - (project config files and READMEs) ```