https://play.google.com/store/apps/details?id=com.emotext.chatapp
This is a messenger with Machine Learning that analyses emotions of a person using Natural Language Processing and shows them to other people they have a conversation with. It helps users interact and communicate better.
My part
- JavaScript + Node.js -> language for most of the backend.
- Express.js -> Node.js framework for making the APIs.
- Flask -> Python framework for making ML APIs. (connects to our main Node.js APIs)
- PostgreSQL -> database used for the backend. (connects to our main Node.js APIs)
- Socket.io -> technology used for making realtime connections with the client apps. (used with Node.js)
- Travis.CI -> used for automated testing when the new version of the server is pushed.
- Docker + Docker Compose -> technology that packs out app in a mini Linux Virtual machine so the setup is the same on every device we run it on.
- Mocha + Chai -> automated testing technologies for Node.js. (used with travis.ci)
- Postman -> library for sending emails using Node.js. (used for user authentication)
Dev's part
- Python -> language for the machine learning part.
- Pandas, Keras, Tensorflow -> libraries used for machine learning.
- Java
- Android Studio
- Socket.io Client Link to GitHub repo: https://github.com/devr0306/EmoText
- Swift
- SwiftUI
- XCode
- Socket.io Client Link to GitHub repo: https://github.com/rcbxd/messaging-app-client
Make sure Docker is installed on your computer and that you have an account in it.
Clone the project onto your own machine.
Run the docker-compose build and docker-compose up commands to run the project.
Run the docker-compose down command to close the project.
Currenly implemented with Docker but really easy to run.
Use docker-compose -f "deploy-docker-compose.yml" build and docker-compose -f "deploy-docker-compose.yml" up to run the deploy enviroment.
TODO: setup Nginx
The server and the database will always be running unless you use the command to close it
The following commands are responsible for testing, installing, and starting the project both on Node and Python
Use docker-compose -f "docker-compose-ci.yml" build and docker-compose -f "docker-compose-ci.yml" up to run the tests for the Node server.
CHECK THE MODELS FOLDER TO SEE THE STRUCTURE OF THE OBJECTS THAT WILL BE RETURNED BY THE API
Socket.io allows us to send data in real time.
Everything is listed in routes/sockets.js
the second line, io.sockets.on.("connection") is what happens when a device is connected to the socket.io server. (should be done is some root file or main component). this will trigger the event that sets the user status to Online. (not working yet)
when disconnected we set the the status to offline.
when we open up a chat, we join a socket room.
we give two arguments, isGroup (whether the chat is a group chat) and chatID
then when we do something with a chat on the client, we emit an event on the client.
let's say we send a message. the server gets the event with the message and emits another event with the same object to all other clients in that chat. same is for all other chat events, like kicking a user out, changing the name, and so on.
to track the users, we would want to use watch-user event, where we pass the userID of the user we want to watch. it also joins a room, and then checks for the changes in that room just like with the chats. the client can join multiple socket.io rooms at once, so when you load your contact list, for example, you would want to emit contacts.length events, each time passing the user object.
when catching an event on the client you just need to update that user with the new value.
Every time the API gets a request, it will return the data in the following structure:
{
success: true/false,
message: 'Yay, Cool'/'Failure with the code',
((optionally depending on the api)user): (user data)
}
With APIs like Verify Token you can check the success of the operation by looking at the success state.
If it's true it's valid
If not, then the message will tell you why.
Auth - users and authentication – TESTED
Contacts – TESTED
Chats - and chats – TESTED
Request URL http://{our_ip}:5000/api/auth/signup/
Method - POST
Accepts a name, a username, an email and a password in the body.
Creates an account, later a user should be redirected to the login page to login or he should be logged in using another API call.
Request URL http://{our_ip}:5000/api/auth/signin/
Method - POST
Accepts an email and a password in the body.
An email can either be a username or an email, it's just a field name
Returns a user session token,
which should be stored in the device/browser to identify the user AND to keep him signed in.
Request URL http://{our_ip}:5000/api/auth/verify/
Method - GET
Accepts an authentication token in the query.
Returns whether the token is valid, check the success variable.
Should be used on app startup to check whether the user login session is still valid.
Request URL http://{our_ip}:5000/api/auth/logout/
Method - GET
Accepts an authentication token in the query.
Deactivates the user login session.
Request URL http://{our_ip}:5000/api/auth/get-user-by-token/
Method - GET
Accepts an authentication token in the query.
Gives away a user object containing all info about the user.
Request URL http://{our_ip}:5000/api/auth/get-reset-token/
Method - POST
Accepts an email in the body.
Sends an email reset token to the email that was gives.
Request URL http://{our_ip}:5000/api/auth/verify-reset-token/
Method - GET
Accepts a password reset token in the query.
Returns whether the password reset token is valid and if it can be used to reset the password.
Should be used on the password reset screen to check if the token you entered is valid.
Request URL http://{our_ip}:5000/api/auth/reset-password/
Method - POST
Accepts a password reset token and the new password in the body.
Changes the password to the one you provided.
Request URL http://{our_ip}:5000/api/auth/get-user-by-id/
Method - GET
Accepts an authentication token in the query.
Returns the user object.
Request URL http://{our_ip}:5000/api/auth/change-bio/
Method - POST
Accepts an authentication token and the new bio in the body.
Changes you bio to the new one.
NOT IMPLEMENTED YET
Request URL http://{our_ip}:5000/api/auth/update-profile-picture/
Method - POST
Accepts an authentication token and the profilePicture file in the body.
Request URL http://{our_ip}:5000/api/auth/change-privacy-settings/
Method - POST
Accepts an authentication token, seeEmail, textMe, seeRealName in the body.
Important
All the variables except for the token HAVE TO BE NUMBERS
0 -- ALLOW EVERYBODY
1 -- ALLOW CONTACTS ONLY
2 -- ALLOW NOBODY
Request URL http://{our_ip}:5000/api/contacts/find-contacts/
Method - GET
Accepts the searchQuery in the query.
Request URL http://{our_ip}:5000/api/contacts/send-friend-request/
Method - POST
Accepts the token and the friend ID in the query.
Request URL http://{our_ip}:5000/api/contacts/ignore-friend-request/
Method - POST
Accepts the token and requestID in the body.
Request URL http://{our_ip}:5000/api/contacts/decline-friend-request/
Method - POST
Accepts the token and requestID in the body.
Request URL http://{our_ip}:5000/api/contacts/cancel-friend-request/
Method - POST
Accepts the token and requestID in the body.
ONLY THE USER WHO SENT THE REQUEST CAN CANCEL IT
Request URL http://{our_ip}:5000/api/contacts/accept-friend-request/
Method - POST
Accepts the token and requestID in the body.
Request URL http://{our_ip}:5000/api/contacts/rename-friend/
Method - POST
Accepts the token and friendID and name in the body.
Request URL http://{our_ip}:5000/api/contacts/decline-friend-request/
Method - POST
Accepts the token and friendID in the body.
Request URL http://{our_ip}:5000/api/contacts/get-friend-requests/
Method - GET
Accepts the token in the body.
WILL RETURN THE FRIEND REQUEST OBJECTS
requests
Request URL http://{our_ip}:5000/api/contacts/get-contacts/
Method - GET
Accepts the token in the body.
WILL RETURN THE FRIEND REQUEST OBJECTS
contacts
Request URL http://{our_ip}:5000/api/messaging/send-message/
Method - POST
Accepts the token, text, chatID, and isGroupChat in the body.
Request URL http://{our_ip}:5000/api/messaging/delete-message/
Method - DELETE
Accepts the token, text, chatID, messageID, and isGroupChat in the body.
Request URL http://{our_ip}:5000/api/messaging/edit-message/
Method - POST
Accepts the token, text, chatID, messageID, and isGroupChat in the body.
Request URL http://{our_ip}:5000/api/messaging/search-message/
Method - GET
Accepts the token, chatID, searchQuery, and isGroupChat in the body.