README.md

RealTimeChatMessenger

Report Bug � Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Installation - Server
  • Installation - Client
• Contributing
• License
• Contact
• Acknowledgements

About The Project

This project is a chat messenger built to handle multiple logged users in a WebSocket Server.

I developed this during a coding test week when I was applying to an opportunity in an USA Company.

Built With

Server-side:

• express
• postgres
• docker
• socket.io
• chai
• mocha

Client-side:

• react
• redux
• material-ui

Getting Started

Prerequisites

• Have node and npm on your machine
• Have docker or have postgres on your machine

Installation

1. Run

git clone git@github.com:EddJesus/RealTimeChatMessenger.git RealTimeChatMessenger

Installation-Server

1. Run

cd server

2. Run

npm install

3. create a .env using the .env.example and your own credentials (OBS: you must set PORT as 3001)

4. create a .env.db using the .env.db.example and your own credentials

5. You can choose 5.1 or 5.2 way

5.1 run a postgres locally on your machine:

OR:

5.2 use docker:

sudo docker-compose up

6. Run

npm run seed

7. Run

npm run dev

Installation-Client

1. Run

cd client

2. Run

npm install

3. Run

npm start

Usage

After running the server and the client correctly, just open the client and there you must know what to do 😉! Play!

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

LinkedIn