Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 5.6 KB

README.md

File metadata and controls

77 lines (58 loc) · 5.6 KB
Raw

chat-exercise

Description

Just a simple example to show and practice code skills resolving the implementation of a simple chat application between two person.

Serverside implemented with Meteor with the out of the box DB provided: Mongodb

The technology stack additionally used is: React v.16 to render UI, Graphql as data query language, Apollo to connect graphql with React.

The application model is based on 3 entities.

  • User (using meteor accounts-password and a hardcoded password so user just need to remember their userName). For just the scope of the example, I won't store users on db.
  • ChatRoom Each time someone select one of the users register ( Meteor.users ) in the application, we create a new ChatRoom for the two user (Selected user and the Meteor.userId() ). Of course if this chatRoom exist, we just get it. To know who belongs to each ChatRoom, we will have the following properties: createdAt, member1: User, member2: User.
  • Message Well each time someone write something, we store the message content. We store, the from, content, createdAt and of course chatRoomId.

In terms of syntax, babel heavily used to get the best of last es6 features (stage-0) and eslint with prettier to have a consistent code style across the application. Additionally to import *.graphql in the code using babel-plugin-inline-import

Let's use font-awesome to add some icons to make it a bit better.

The application is designed to have one entry point, and make mandatory people to

Run the project in local

Of course we need to have node installed in our computer.

The server side is quite simple to install just execute:

curl https://install.meteor.com/ | sh

Then go the folder of the project and run in the terminal:

meteor npm install && npm start

!! Meteor will run npm that has been bundled with meteor. So important to install the dependencies with meteor npm install ( using meteor version so no conflicts when running )

And you should have the application up and running in localhost:3000.

TODOs

  • Create the project with meteor and plan the execution.
  • Add .babelrc & .eslintrc with prettier configuration.
  • Add needed dependencies to the package.
    • babel && eslint && devDependencies: babel-core babel-eslint babel-preset-env babel-preset-react babel-preset-stage-0 babel-plugin-inline-import eslint eslint-config-airbnb eslint-config-prettier eslint-plugin-html eslint-plugin-jsx-a11y eslint-plugin-prettier prettier eslint-plugin-import eslint-plugin-import
    • react: react react-dom prop-types
    • apollo: apollo-client apollo-client-preset react-apollo apollo-client-preset apollo-utilities
    • graphql: graphql-server-express express graphql body-parser graphql-tag graphql-tools
    • meteor dependencies(.meteor/packages): meteor npm install --save apollo-client react react-dom react-apollo apollo-link apollo-link-http apollo-cache-inmemory apollo accounts-password bcrypt
    • subscriptions: subscriptions-transport-ws v0.5.4 apollo-link-ws graphql-subscriptions v0.3.1
    • utilities && cosmetics: font-awesome lodash
  • Create the needed structure recommended by Meteor and generating backbone of the application.
  • Generate graphql api definition (User, ChatRoom, Message).
  • Decide which style approach to using (BEM).
  • Create Login component and basic Auth Components: Register & Login / Application & Logout (No really password, just for demo porpoises )
  • Create ChatRoomsSelection component (just allow you to select one of all the Users, if too many people is here we should think in a way to reduce the User to be selected...).
  • Have subscription working with Users. Best information about on appollohql -> No working because of some issues. Moving to ddp-apollo to connect with apollo-client v2.
  • Create one ChatRoomMessages component (only show if a chat has been selected).
  • Create one ChatForm component (only show if a chat has been selected, to create the messages).
  • Send newMessageEvent only to the proper channel, with the withFilter helper to split up events by which channel they are for.
  • Able to reload available people to chat with as soon as they logging in the system.
  • Work on the styles for mobile first only design. Just a simple grid with 3 sections (header, main, footer)
  • Place your own messages are on the right hand side in a green bubble and the other persons messages are on the left hand side in a grey bubble.
  • Implement commands in chatForm messages:
    • /nick - sets your name for the chat
    • /think - makes the text appear in dark grey, instead of black
    • /oops - removes the last message sent
  • Polish styles and UX. (I think not bad for the time I spent 🤓)
  • [-] Create some extras functionalities for commands:
    • When the user is typing, indication that they are typing should be shown to the other user. (TODO add just a simple mutation and call a pubsub.publish with a new event, it won't be persistent)
    • (smile) should produce a smiley face, (wink) should produce a winking face
    • When a new message arrives, it should slide in, and the messages above slide up.
    • /fadelast - would fade out the last message to 10% visibility
    • /highlight - would make the font of the message 10% bigger, and make the background 10% darker