Skip to content

Commit aea0d67

Browse files
authored
Define frontend poc readme
1 parent b7ec49b commit aea0d67

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1-
# react-concept
1+
# react-concept
2+
Frontend proof of concept of CodeBuddies v3 using React.
3+
4+
For Backend proof of concepts, see:
5+
+ [Django](https://github.com/codebuddies/django-concept)
6+
+ [Serverless](https://github.com/codebuddies/serverless-concept)
7+
+ [Node](https://github.com/codebuddies/node-concept)
8+
+ [Go](https://github.com/codebuddies/go-concept)
9+
10+
## Design
11+
View proof of concept designs over at [Figma](https://www.figma.com/file/wXMeX9xgYTcVKNJ1XT9ZQ5/cbv3poc?node-id=0%3A1). Note that the design are only meant to serve as a guide and the output does not need to be pixel perfect based on the designs linked here. Instead, use [Material-UI](https://material-ui.com/) components as a starting point and extend as needed.
12+
13+
The PoC for the frontend will revolve around querying and posting the Resource model based on the defined [API spec](https://app.swaggerhub.com/apis-docs/billglover/CodeBuddies/0.0.1).
14+
15+
## Pages
16+
**Index**
17+
18+
The main landing page will have a small copy as well as a Sign Up and Sign in form (see You can find these pages at [Figma](https://www.figma.com/file/wXMeX9xgYTcVKNJ1XT9ZQ5/cbv3poc?node-id=0%3A1) for reference).
19+
20+
After authenticating, the root page should be defined as the **Resources Index** page.
21+
22+
**Resources**
23+
24+
The Resources page displays a search form. From this page, a user can search for a resource and add a new resource. After searching for a resource, it should populate with the search results. Clicking on `Add a Resource` should open a modal with a form to add a Resource. On success, it should give a message that a resource was added successfully, or if there are errors, display error messages in an [flash message](https://material-ui.com/components/snackbars/).

0 commit comments

Comments
 (0)