diff --git a/README.md b/README.md index 25e9f9f..9bb890c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # ECHO CHAT -This is a minimal messaging app built with react on top of a node express server and socket.io. +Echo chat is a simple messaging app that lists users loggedin to a site and start a conversation with any of the listed members. -To run this app , in the root +This is a minimal messaging app built with react on top of a node-express server and socket.io.The app implements a local authentication system as well as google authentication. The user data and sessions are stored in a mongodb database hosted on mongo atlas. + +To run this app , in the root setup .env file with google client id client secret and mongodb uri, then run ``` npm run install @@ -14,3 +16,14 @@ Or you can build the react app and serve it with express server running on the s ``` npm run deploy ``` + +### Frameworks and libraries + +This app uses mulitple libraries here are libraries used for the server. + +- Express +- passport +- bcrypt +- mongoose +- socket.io +- jest