Browse Source

optional: desktop application

pull/660/head
lee 4 years ago
parent
commit
5bd7be3689
  1. 62
      subjects/social-network/cross-platform-appimage/README.md
  2. 85
      subjects/social-network/cross-platform-appimage/audit.md

62
subjects/social-network/cross-platform-appimage/README.md

@ -0,0 +1,62 @@
## App image
### Objectives
For this optional, `cross platform app image`, you will have to implement a desktop app using [Electron](https://www.electronjs.org/):
This desktop app should have as principle objective the creation of a messenger, just like facebook or discord. It should be able to run in multiple platforms : windows, linux and macOS.
You will have to create:
- A way to see which users are online (able to talk)
- A way to notify the user whenever he/she receives a message
- A real time communication between the users that are chatting
- A section for emojis, where users can send to each other
- An offline possibility here you can see all messages from all users, but can not send messages to them or receive. You must inform the user that he/she is offline/online
- A search engine to search for a messages
We encourage you to add any other additional features that you find relevant.
### Instructions
You must use a method of authentication for the app.
To be able for the users to use the app you must create a login form, the user should provide:
- Email
- Password
If the user does not present a registration, then the app should redirect to the social network website (mandatory project) so that the user can register himself.
When the user logs in or registers he should stay logged in until he/she chooses a logout option that should be available at all times. Even when the user exits the app and opens it again it should continue logged in until the [session](https://www.electronjs.org/docs/api/session) expires (the time limit is up to you to decide) or the user decides to logout.
#### Websocket
The use of websocket must be present in this project:
- You must be able to send messages in real time just like the [mandatory project](https://public.01-edu.org/subjects/social-network/), you should be able to send chat messages using the website as an user, to the desktop app as another user.
- To see the status of a user, whenever a user goes online/offline the status must change automatically, in real time. So when a user goes offline all the followers must be able to see that the user went offline and its not available to talk. The same happens when the user goes online, all followers must see that he/she is online.
---
#### Offline
If the internet connection goes down or the user does not have internet, the app should warn the user that there is no connection by displaying a message to say so. The offline mode allows the user to view all the messages sent, but if the user tries to send a message it should display the same error message as the first one.
Here's a tip [offline/online](https://www.electronjs.org/docs/tutorial/online-offline-events)
The code must respect the [**good practices**](https://public.01-edu.org/subjects/good-practices/).
---
#### Search
The search should be interactive, in other words, the results should be displaying as you write, not needing a button for you to click.
This project will help you learn about:
- Data manipulation and local storage
- Authentication
- Desktop Applications:
- [Electron](https://www.electronjs.org/docs)
- Websocket

85
subjects/social-network/cross-platform-appimage/audit.md

@ -0,0 +1,85 @@
#### General
###### Does the app implement sessions for the authentication of the users?
###### Are the correct form elements being used in the login? (Email, Password)
###### Can you confirm that it is possible to send emojis to other users using the desktop app?
#### Functional
##### Try to register a user.
###### Did the app redirect the user to the social network site?
##### Try to log in the desktop app with the user you just registered.
###### Did the login worked without problem?
##### Try to log in with the user you created, but with a wrong password or email.
###### Did the app detect if the email or password was wrong?
##### Log into the desktop app, then close the app and open it once more.
###### Did the app log in automatically, without being needed to log in once more?
##### Log into the desktop app, then logout and close the app, open it once more.
###### Is the app asking for the user to log in?
##### Try and open a browser with the social-network website and the desktop app, log in with different users in each one. Then with the browser try to send a private message to the desktop user.
###### Did the desktop user receive the message in realtime?
##### Using the same browser and desktop app, try to have a chat between the users.
###### Did the chat between the users went well?
##### Using the same browser and desktop app, try to logout the browser user.
###### Did the user went automatically offline (in real time) on the desktop app?
##### Using the same browser and desktop app, try to log into the browser as a follower of the desktop user (so that the desktop user can see him/her).
###### Did the user went automatically online (in real time) on the desktop app?
##### Try to lose the internet connection while being in the app.
###### Is there some kind of warning that the user lost internet connection?
##### Try to send a message to a follower while offline.
###### Did the app warn that there is no internet connection?
##### Try to search for something in a chat.
###### Is the search engine interactive? (as you write the results are displayed)
##### Try going to the chat conversation between two users, then search for a specific message.
###### Did it output the expected result?
##### Try to run a [VM](https://www.virtualbox.org/) (virtual machine) with Windows, then install the social network desktop application.
###### Did the app installed without any problems?
##### Using this VM, open the app and and repeat all the previous questions.
###### Does the app behave like it should?
##### Try to run a [VM](https://www.virtualbox.org/) (virtual machine) with macOS, then install the social network desktop application.
###### Did the app installed with out any problems?
##### Using this VM, open the app and and repeat all the previous questions.
###### Does the app behave like it should?
#### Bonus
###### +Does the app have an External Authentication? (Github, Google, etc)
###### +Does the search engine include operators? (include, exclude or fuzzy)
###### +Does the search engine include operators for numbers? (equal, not equal, greater than, lesser than)
Loading…
Cancel
Save