Skip to content

Latest commit

 

History

History
156 lines (104 loc) · 3.49 KB

README.md

File metadata and controls

156 lines (104 loc) · 3.49 KB
Raw

CHAT.IO

forthebadge forthebadge forthebadge

📃 About

A chat app where users can send messages to each other. This project’s backend and frontend has an authentication system. It achieves real-time communication using socket.io and has many amazing features.

Few Awesome Features 🕹

  • Send and receive messages in real-time 📧
  • Update Profile 👨🏻‍🏫
  • Upload and send files 📁

🌱 Quick Start

  • Star🌟 and Fork this repository

  • Clone this repository remotely.

git clone https://github.com/blackphoenix42/chat-app.git`

Backend 🌐

  • Download and install PostgreSQL🐘

  • Navigate to backend directory

cd .\backend\
  • Install the dependencies
npm install

  • Add PostgresSQL databse password in .env.EXAMPLE file and remove .EXAMPLE from the extension.

  • Create chat_app database in pgAdmin. (You can provide a different name but change it too in the .env file.)

  • In the terminal, run the following command to create tables in database

npx sequelize-cli db:migrate
  • Send dummy data to the database.
npx sequelize-cli db:seed:all
  • Start the server
npm start

Frontend 💻

  • Navigate to frontend directory
cd .\frontend\
  • Install the dependencies
npm install
  • Start the app
npm start

🔑Credentials

Use following credentials to try out the app.

email:john.doe@gmail.com
password:secret

📚 Technology Stack

  • React
  • Nodejs
  • Express
  • PostgreSQL

🚀 How to Contribute to Chat-App?

  • Take a look at the Existing Issues or create your own Issues!
  • Check out CONTRIBUTING.md
  • Start contributing to add yourself in README.md 🤙🏻

👾 Project Admin


blackphoenix42
👑 Admin