This project is a straightforward chat application. It uses websockets for communication between server and clients, and updates the chat screen in real time.
The project was built with the MERN stack for web development (MongoDB, Express, React.js, Node.js)
The application can be installed and tested in a few simple steps.
- Clone the repo, and open the cloned repo's folder.
git clone https://github.com/grrbm/chat-mern.git- Open 'backend' folder and install
npm install- Open 'frontend' folder and install
npm install- Open a new terminal and run MongoDB
mongod- Open a second new terminal, and run the server from the project root
npm run server- Open a third new terminal, and run the client from the project root
npm startAs a Regular User, your basic use case is to join the chat room to send/receive messages. When a new username and password combination is used on the Join Screen (one that the server hasn't seen before), a new User is created in the database via a call to the backend.
You can also login as an Admin, for testing purposes. The admin credentials are populated in the database the first time you run the server. The admin credentials are the following:
username: admin
password: adminpass
As an admin, you have access to the Admin Area panel.
You can use this panel to filter the chat's messages by Date and Time, as well as by username. It's also possible to reverse the order the chat's messages appear, Newest or Oldest messages first.
Distributed under the MIT License. See LICENSE for more information.
Guilherme Reis - LinkedIn - Portfolio - [email protected]
Project Link: https://github.com/grrbm/chat-mern