Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 2.11 KB

README.md

File metadata and controls

87 lines (59 loc) · 2.11 KB
# Scalable Chat App with Redis, Socket.io, Node.js, Next.js, and TypeScript

Welcome to the Scalable Chat App, a powerful and scalable real-time chat application built with Redis, Socket.io, Node.js, Next.js, and TypeScript.

## Getting Started

To start using the application, follow these steps:

### Clone the Repository

```sh
git clone <repository-url>
cd  ScaleableChatApp
cd  ChatApp

Install Dependencies

yarn install

Start the Application

yarn dev

This will launch the development server and make the application accessible at http://localhost:3000.

Features

  • Real-time messaging using Socket.io
  • Scalable architecture with Redis integration
  • Server-side rendering and routing with Next.js
  • Strong typing and enhanced developer experience with TypeScript

Technologies Used

Folder Structure

The repository is organized as a Turborepo, containing the following packages and apps:

  • docs: a Next.js app for documentation
  • web: a Next.js app for the chat interface
  • @repo/ui: a React component library shared by both web and docs applications
  • @repo/eslint-config: ESLint configurations (including eslint-config-next and eslint-config-prettier)
  • @repo/typescript-config: TypeScript configurations used throughout the monorepo

Development Commands

Build All Apps and Packages

yarn build

Develop All Apps and Packages

yarn dev

Remote Caching

Turborepo supports remote caching. To enable it, use the following commands:

yarn turbo login # Authenticate with your Vercel account
yarn turbo link  # Link your Turborepo to the remote cache

Useful Links

Feel free to explore and customize the codebase to meet your specific requirements. Happy coding!