diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fbceff9..8846ceb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,6 +74,9 @@ Break down how each folder is used in the repo and how different code file types |-- workflows/ |---- (Github workflow .yaml files) |-- (other github specific files) +- docs/ +|-- architecture.md +|-- (Files helping to break down different sections of the project) - (project config files and READMEs) ``` diff --git a/README.md b/README.md index 1c33c70..5f06ffe 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,13 @@ _This section should try to quickly explain how to setup the project and start u ## Links + - [Code of Conduct] - [Contribute] - [Code Analysis Help] - FAQ? - Wiki? -- Architecture Doc? -- How to understand the application from a developer point of view (webpage-> controllers -> services -> libraries) + ## Contributors diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..e184e2c --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,69 @@ +--- +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 +_Describe the frameworks and libraries this project uses and how to set them up (Example sections provided)_ + +### Client +#### Initial Setup + +### Server +#### 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 +#### Views +1. +2. +#### Workflows +1. +2. + +### Server (REST) API +#### Entry Point +#### Endpoints + +1. List All Notes + + | Method | Endpoint | + |-|-| + | `GET` | `/notes/all` | + + + ##### 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 +_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_