Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Senor101 committed Jun 3, 2023
1 parent b1e9c5d commit ae63244
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

0 comments on commit ae63244

Please sign in to comment.