Product Requirements Documentation

By Haley Zitzmann

Summary

Field	Detail
Blog App	{My Blog}
Description	{I am building a full CRUD application that allows the users to write and post their own blog posts. The user can also post pictures and blog posts will be dated.}
Developers	{Haley Zitzmann}
Live Website	{}
Repo	{}

User Stories

List of stories users should experience when using your application.

• Users should be able to see the site on desktop and mobile
• Users can create a new item
• Users can see all their items on the dashboard
• Users can update items
• User can delete items

Route Tables

Endpoint	Method	Response	Other
/item	GET	JSON of all items
/item	POST	Create new item return JSON of new item	body must include data for new item
/item/:id	GET	JSON of item with matching id number
/item/:id	PUT	update item with matching idea, return its JSON	body must include updated data
/item/:id	DELETE	delete the item with the matching id
/auth/signup	POST	creates new user account returns user JSON	new user info must be included in body
/auth/login	POST	logs in user and returns user JSON with JWT token	username and password must be included in body

Component Architecture

You can use the Mermaid Markdown Syntax to create a chart of how the parts of your frontend website relate to each other. Units should represent components of your page. The following is an example you may see in a Single Page Application like a React App.

flowchart TD
    A[App] --> B(Header)
    A --> C{Components}
    A --> D[Footer]
    A --> E[About Me]
    C --> F[Index]
    C --> G[Show]

Loading