8000 GitHub - sinandredemption/kath
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

sinandredemption/kath

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kath

Kath is a lightweight, retro-style, ephemeral chat app with a small twist: you can see what the other people in the room are typing in real-time.

Landing Page Chat Screen
Landing Page Chat Screen

Quickstart (using docker)

Clone this repo and run the docker-compose stack:

git clone https://github.com/sinandredemption/kath.git && cd kath
docker compose up --build # Or docker-compose up --build

By default, kath would run on http://localhost:5513. To host it at some other URL, modify APP_URL and PORT in .env file.

Kath is built using React and Node.js. To run Kath locally for development purposes, you'll need to set up both the client and server components.

Prerequisites

  • Node.js
  • npm

Steps

Clone this repo

git@github.com:sinandredemption/kath.git

Server setup

Open a new terminal window. Navigate to kath/ and run:

cd server
npm install
npm run dev

The server should now be running on port 3001. Do not close this terminal window to keep the backend server running.

Client setup

Open a new terminal window. Navigate to kath/ and run:

cd client
npm install
npm run dev

Kath should now be running on port 5173. Navigate to http://localhost:5173/ in your browser to see it in action!

Credits

This project utilizes the wonderful NES.css framework for its retro styling.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  
0