Giter Site home page Giter Site logo

chat-mern's Introduction

Table of Contents

About The Project

Product Name Screen Shot

This project is a straightforward chat application. It uses websockets for communication between server and clients, and updates the chat screen in real time.

Built With

The project was built with the MERN stack for web development (MongoDB, Express, React.js, Node.js)

Installation (Windows)

The application can be installed and tested in a few simple steps.

  1. Clone the repo, and open the cloned repo's folder.
git clone https://github.com/grrbm/chat-mern.git
  1. Open 'backend' folder and install
npm install
  1. Open 'frontend' folder and install
npm install
  1. Open a new terminal and run MongoDB
mongod
  1. Open a second new terminal, and run the server from the project root
npm run server
  1. Open a third new terminal, and run the client from the project root
npm start

Usage

As 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

Product Name Screen Shot

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.

Product Name Screen Shot

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Guilherme Reis - LinkedIn - Portfolio - [email protected]

Project Link: https://github.com/grrbm/chat-mern

Acknowledgements

chat-mern's People

Contributors

grrbm avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.