Browse Source

readmes and audits review

content-update
OGordoo 4 years ago
parent
commit
55f91b9e04
  1. 17
      subjects/real-time-forum/README.md
  2. 24
      subjects/real-time-forum/audit/README.md
  3. 6
      subjects/real-time-forum/typing-in-progress/README.md
  4. 12
      subjects/real-time-forum/typing-in-progress/audit.md

17
subjects/real-time-forum/README.md

@ -35,7 +35,6 @@ To be able to use the new and upgraded forum users will have to register and log
- Password
- The user must be able to connect using either the nickname or the e-mail combined with the password.
- The user must be able to log out from any page on the forum.
- The user must be able to consult other people profiles and see everything except the e-mail and the password (obviously).
#### Posts and Comments
@ -47,20 +46,20 @@ This part is pretty similar to the first forum. Users must be able to:
- See posts in a feed display
- See comments only if they click on a post
But there is a twist. If some user creates a post, that post has to be created to all users without refreshing the page and the same goes for the comments. You can achieve this with [WebSockets](https://en.wikipedia.org/wiki/WebSocket).
#### Private Messages
Users will be able to send private messages to each other, so you will need to create a chat, where it will exist :
- A section to show who is online and able to talk to:
- This section must be organized by the last message sent (just like discord), if the user is new and does not present messages you must organize it in alphabetic order.
- The user must be able to send private messages to the users who are online
- This sections must be visible at all times.
- A section that when clicked on the user that you want to send a message, reloads the past messages. Messages that where already sent:
- For this you will have to be able to see the previous messages that you had with the user
- Reload the 10 last messages and when scrolled up to see more messages you must provide the user with 10 more messages. **Do not forget what you learned!! (`Throttle`, `Debounce`)**
- This section must be organized by the last message sent (just like discord). If the user is new and does not present messages you must organize it in alphabetic order.
- The user must be able to send private messages to the users who are online.
- This section must be visible at all times.
- A section that when clicked on the user that you want to send a message, reloads the past messages. Chats between users must:
- Be visible, for this you will have to be able to see the previous messages that you had with the user
- Reload the last 10 messages and when scrolled up to see more messages you must provide the user with 10 more, without spamming the scroll event. **Do not forget what you learned!! (`Throttle`, `Debounce`)**
- Messages must have a specific format:
- A **`date`** that shows when the message was sent

24
subjects/real-time-forum/audit/README.md

@ -22,10 +22,6 @@
###### Are you able to log out in every page?
##### Try to check other people's profiles.
###### Are you able to see their information (other than email and pass)
##### Try to create a post.
###### Are you able to create a post?
@ -34,7 +30,7 @@
###### Are you able to see the post you previously created?
##### Log in as a registered user and try to comment a post
##### Log in as a registered user and try to comment a post.
###### Are you able to comment on the post?
@ -42,14 +38,6 @@
###### Are you able to see the comment you previously created?
##### Open two browsers (ex: Chrome and Firefox) and log in with different users in each one. With one user create a post.
###### Did the other user saw the new post without refreshing the page?
##### Open two browsers (ex: Chrome and Firefox), log in with different users in each one, click on a post with both users and try to comment with one user.
###### Did the other user saw the new comment without refreshing the page?
###### Is there a section designed to show online users?
###### Are the chat users organized by last message sent (just like discord)?
@ -58,17 +46,17 @@
###### Are the chat users organized in alphabetic order?
##### Try to send a message
##### Try to send a message.
###### Does the message respect the format, by using the users name and the date that the message was sent?
##### Open two browsers (ex: Chrome and Firefox), log in with different users in each one and with one of them try to send a private message to the other.
###### Did the other user received the message in real time, without refreshing the page?
###### Did the other user received a notification?
##### Open two browsers (ex: Chrome and Firefox), log in with different users in each one and with one of them try to send a private message to the other.
###### Did the other user received a notification?
###### Did the other user received the message in real time, without refreshing the page?
##### Try to open a private conversation, that has more then 10 messages.
@ -88,9 +76,7 @@
###### +Does the code obey the [good practices](https://public.01-edu.org/subjects/good-practices/README.md)?
###### +Can the users edit their profile?
###### +Can the users add a photo to their profile?
###### +Does the users have profiles?
###### +Can the users send images through the private messages?

6
subjects/real-time-forum/typing-in-progress/README.md

@ -12,16 +12,16 @@ For this project you must create:
A typing in progress engine is a way that people can see that a user is typing in real time. Allowing you to see the other user is replying or sending a message.
The typing in progress engine must work in real time! This meaning that if you start typing to a certain user this user will be able to see that you are typing
The typing in progress engine must work in real time! This meaning that if you start typing to a certain user this user will be able to see that you are typing.
This engine must have/display:
- A websocket to stablish the connection with both users
- An animation so that the user can see that you are typing, this animation should be smooth (no interruptions/janks) and just enough to draw attention for the user to see (user friendly)
- The name of the user that is typing
- When ever the user stops typing or finishes the conversation, it should not display the animation
- Whenever the user stops typing or finishes the conversation, it should not display the animation
For help displaying the typing in progress you can take a look on the js [event](https://developer.mozilla.org/en-US/docs/Web/Events) list, primarily the **Keyboard events** and the **Focus events**
To help with the display of the typing in progress you can take a look on the js [event](https://developer.mozilla.org/en-US/docs/Web/Events) list, mainly the **Keyboard events** and the **Focus events**
This project will help you learn about:

12
subjects/real-time-forum/typing-in-progress/audit.md

@ -2,23 +2,19 @@
##### Open two browsers (ex: Chrome and Firefox or private windows) and log in with different users in each one. With one user start typing.
###### Can you confirm that the typing in progress engine works?
###### Is there any animation confirming that the typing in progress is working?
##### Using the same two browsers, start typing with one of the users.
###### Can you confirm that the typing in progress has the name of the user that is typing?
##### Using the same two browsers, start typing with one of the users.
###### Is there any animation from the typing in progress
###### Does the animation work smoothly, without movement interruptions?
##### Using the same two browsers, start typing with one of the users.
###### Does the animation work smoothly, without movement interruptions?
###### Is the animation from the typing in progress engine user friendly (easy to understand/see)?
##### Using the same two browsers, start typing with one of the users.
###### Is the animation from the typing in progress engine user friendly (easy to understand/see)?
###### Can you confirm that the typing in progress has the name of the user that is typing?
##### Open two browsers (ex: Chrome and Firefox or private windows) and log in with different users in each one. With one user start typing and then stop.

Loading…
Cancel
Save