Skip to content

Commit 19630b0

Browse files
committed
Readme
1 parent adcef45 commit 19630b0

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

README.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@ I'm Yohan Arias and this is the [Planning Poker](https://en.wikipedia.org/wiki/P
66
The app is build using NodeJS, VueJS including their respectives Frameworks (AdonisJS and Quasar).
77
These frameworks let us keep a clean code using best practices.
88

9-
## The Planning Poker Dashboard
9+
## The Planning Poker System
1010

11-
[![See demo interface](https://user-images.githubusercontent.com/281727/100144788-13509980-2e76-11eb-8ae4-264f94928225.png)](https://codepen.io/emilioastarita/pen/NWRKWwv)
11+
![See demo interface](./screenshots/login.png)
12+
![See demo interface](./screenshots/dashboard.png)
1213

1314
### At backend layer we have a NodeJS app:
1415

@@ -24,7 +25,7 @@ The Rest API has the following endpoints:
2425

2526
##### `POST /issue/{:issue}/join` - Used to join `{:issue}`.
2627
- If issue not exists generate a new one.
27-
- Must receive a payload with the intended name. ie: `{"name": "florencia"}`
28+
- Must receive a payload with the intended name. ie: `{"name": "Yurmira"}`
2829

2930
##### `POST /issue/{:issue}/leave` - Used to leave `{:issue}`.
3031
- When the user wants leave the issue
@@ -41,9 +42,9 @@ The Rest API has the following endpoints:
4142
{
4243
"status": "voting",
4344
"members": [
44-
{"name": "florencia", "status": "voted"},
45-
{"name": "kut", "status": "waiting"},
46-
{"name": "lucho", "status": "passed"}
45+
{"name": "Yurmira", "status": "voted"},
46+
{"name": "Juan", "status": "waiting"},
47+
{"name": "Yohan", "status": "passed"}
4748
]
4849
}
4950
````
@@ -52,9 +53,9 @@ The Rest API has the following endpoints:
5253
{
5354
"status": "reveal",
5455
"members": [
55-
{"name": "florencia", "status": "voted", "value": 20},
56-
{"name": "kut", "status": "voted", "value": 20},
57-
{"name": "lucho", "status": "passed"}
56+
{"name": "Yurmira", "status": "voted", "value": 20},
57+
{"name": "Juan", "status": "voted", "value": 20},
58+
{"name": "Yohan", "status": "passed"}
5859
],
5960
"avg": 20
6061
}
@@ -96,5 +97,5 @@ Check if services are up and running:
9697
9798
## Unit testing
9899
99-
- Run npm run test on backend_node
100+
- Run `npm run test` on backend_node
100101

screenshots/dashboard.png

48.2 KB
Loading

screenshots/login.png

18.8 KB
Loading

0 commit comments

Comments
 (0)