Skip to content

Latest commit

 

History

History
103 lines (82 loc) · 3.99 KB

README.md

File metadata and controls

103 lines (82 loc) · 3.99 KB
Raw
Logo

Chat App

Simple pet project of Chat App
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started

About The Project

This project is a full-stack chat application using the latest technologies and frameworks. It is designed to provide an easy to use and functional chat experience. I have combined Node.js, Vue, and Socket.io to create an efficient and robust chat application.

The application consists of both a client-side and server-side component. On the client side, i am using Vue and Socket.io to create a powerful and interactive user interface. On the server side, i am using Node.js and Express to create a secure API to manage chat rooms and messages.

This project is designed to allow users to create rooms, join them, and send and receive messages in real-time. I have implemented a variety of features to make the experience of using the application easier and more enjoyable.

Full project is built from scratch by me. Design, frontend, backend, and other stuff were made by myself. I think this is pretty impressive pet project for developer, who has been learning about 6 months.

(back to top)

Built With

As mentioned above, key technologies are Vue, Node.js and Socket.io, but there are more to mention in the list:

Front-end:

  • Vue.js
  • Vite
  • SASS as SCSS
  • TypeScript (both client and server sides)

Back-end:

  • NodeJS
  • Express.js
  • JWT
  • MongoDB

(back to top)

Getting Started

In order to start this project from local PC, you need to follow this steps below:

Installation

  1. Clone the repo 
    git clone https://github.com/sweeeeetch/chatApp.git
  2. Install NPM packages in both client and server folders 
    npm install
  3. Make .env files in client and server folders
    • For client folder .env should contain only one line: 
      VITE_APP_HOST_URL=<your-local-host>
    • For server folder it has couple lines more: 
      PORT=8000
MONGODB_URI=<your-mongo-db-uri>
SECRET_KEY=<secret-key-for-jwt-token>
  4. Run in both folders starting script and you are settled! 
    npm run dev

(back to top)