Skip to content

Commit 772e680

Browse files
authored
Update README.md
1 parent b0ac061 commit 772e680

File tree

1 file changed

+90
-16
lines changed

1 file changed

+90
-16
lines changed

README.md

Lines changed: 90 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ An educational student app project originally designed for [Learn JavaScript wit
66

77
## Instructions
88

9-
Create a repository and implement your own Checkin app. Feel free to recruit other people and work in groups (ideally 2 - 7 people). Recruit your team in the [JavaScript Questions Chat](https://gitter.im/learn-javascript-courses/javascript-questions).
9+
Fork this repository and implement your own CheckIn app.
1010

11-
Can't find a team? No problem. Fly solo and keep all the glory.
1211

12+
## Tech Stack Checklist
1313

14-
## Things to Keep in Mind
14+
* [Use Next.JS](https://nextjs.org/)
15+
* [Setup automatic lint and prettier runs](https://medium.com/javascript-scene/streamline-code-reviews-with-eslint-prettier-6fb817a6b51d)
16+
* [Deploy on Vercel](https://vercel.com/)
17+
* [Authenticate users with Magic](https://magic.link/)
18+
* [Store data in Firebase](https://firebase.google.com/)
19+
* [Don't commit secrets to the repo](https://nextjs.org/docs/basic-features/environment-variables)
20+
21+
Related: [The 12-Factor App](https://12factor.net/)
1522

16-
* Not sure where to start? Try [Next.js](https://zeit.co/blog/next).
17-
* Favor functional components over class-based components when it makes sense.
18-
* Use **pure functions** wherever you can. A pure function does not mutate anything outside itself. A pure function does not produce side effects. Given the same inputs, a pure function will always return the same output.
19-
* Notice how much of the program state can be represented as lists of things:
20-
- A list of users.
21-
- A list of teams.
22-
- A list of checkins.
2323

2424
## What's a Scrum Checkin?
2525

@@ -44,11 +44,71 @@ Don't worry about anything but getting the user interfaces to work. No need for
4444

4545
* Allow a user to create and name teams. Users own the teams they create.
4646
* Allow a user to check in with a specific team and answer each of the three scrum questions.
47-
* View the team status: A simple display of all the team's checkins for today (or any day in the past).
47+
* View the team status: A simple display of a running log of all the team's checkins, grouped by day.
48+
49+
Here's a sketch of the checkin feature.
50+
51+
## Screen 1:
52+
53+
---
54+
Your last checkin said you would:
55+
56+
* [ ] Write the README for the checkin app
57+
* [ ] Document the stack requirements
58+
* [ ] Complete 2 code reviews
59+
* + Add another item
60+
61+
Were there any blockers? If so, please list briefly below (one line each):
62+
63+
* + Add a blocker from your previous checkin
64+
65+
Please check the items you completed, and add any additional items you completed.
66+
67+
[ Done ]
68+
---
69+
70+
## Screen 2:
71+
72+
---
73+
What will you work on today? (Try to list 3-5 things you think you can **complete** today.
74+
75+
* [ ] <Priority 1 Task>
76+
* [ ] <Priority 2 Task>
77+
* [ ] <Priority 3 Task>
78+
* + Add another task you can probably complete today
79+
80+
Do today's tasks have any blockers? If so, please list them briefly, below:
81+
82+
* + Add a blocker for today's tasks
83+
---
84+
85+
86+
## Screen 3:
87+
88+
---
89+
Great! How are you feeling today?
4890

49-
Here's a simple mock-up of the checkin feature. Feel free to improve on the UI:
91+
🙁 😐 😃
92+
93+
94+
1 - 5 words, what are we doing well?
95+
96+
[ <text input> ]
97+
98+
99+
In 1 - 5 words, what needs improvement?
100+
101+
[ <text input> ]
102+
---
103+
104+
## Screen 4:
105+
106+
---
107+
108+
That's it. Have a great day! 🎉
109+
110+
---
50111

51-
<img width="446" alt="screen shot 2015-10-08 at 7 35 58 pm" src="https://cloud.githubusercontent.com/assets/364727/10384095/5dcd3592-6df4-11e5-926e-a1afb3f51864.png">
52112

53113

54114
### Mid Level Requirements
@@ -59,9 +119,10 @@ Here's a simple mock-up of the checkin feature. Feel free to improve on the UI:
59119

60120
### Advanced Requirements
61121

62-
* Integrate with Github and let users link updates to the current issue they're working on.
63-
* Automate checkin updates by adding assigned project issues from GitHub to the user's status.
64-
* Add realtime capability and update today's checkins view when another user checks in.
122+
* Integrate with Github. On the "What will you work on today?" feature, provide an option to link a GitHub issue from their assigned issues.
123+
* Automate checkin updates to mark items as done when linked issues get closed on GitHub.
124+
* Add realtime capability and update today's checkins view as checkins are added, statuses change, and checklist items get marked complete.
125+
65126

66127
## To Implement:
67128

@@ -70,3 +131,16 @@ Here's a simple mock-up of the checkin feature. Feel free to improve on the UI:
70131
3. Open an issue with a link to your fork.
71132

72133
To get credit, you must [open an issue](https://github.com/learn-javascript-courses/checkin/issues/new?title=Challenge+completed+level:+basic/mid/advanced) with a link to your fork.
134+
135+
136+
## License Terms
137+
138+
By implementing the app described above and posting it publicly on GitHub, you agree to the following license terms:
139+
140+
**"You"** or **"Your"** means the rights holder. **"Contributions"** means any software, images, audio, or other creative work produced by you during the course of working on this project. **Recipients** means anyone who recieves the software by any means, in any medium, or through any distribution channel.
141+
142+
* **You Own Your Creative Work.** You reserve all right, title, and interest in and to Your Contributions. You may use your solo projects in your portfolio.
143+
* **Grant of Copyright License.** Subject to the terms and conditions of this Agreement, You hereby grant to Recipients of this software a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
144+
* **Grant of Patent License.** Subject to the terms and conditions of this Agreement, you hereby grant to recipients of this software patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work.
145+
146+
You represent that you are legally entitled to grant the above license.

0 commit comments

Comments
 (0)