Skip to content

Jared-MB/open-js-chat

Repository files navigation

OpenJS Chat

OpenJS Chat is a monorepo built using Turborepo, featuring a Next.js client and a NestJS server. This project provides on open source chat application thinking in a easily adaptability to your needs.

Monorepo Structure

OpenJS-Chat/
├── apps/
│   ├── chat/     # Next.js frontend
│   ├── server/   # NestJS backend
├── packages/     # Shared packages
├── .turbo/       # Turborepo cache
├── package.json  # Monorepo package manager config
├── turbo.json    # Turborepo configuration
└── README.md     # Documentation

Tech Stack

Setup & Installation

Prerequisites

Ensure you have the following installed:

Installation

Clone the repository and install dependencies:

git clone https://github.com/Jared-MB/open-js-chat.git
cd open-js-chat

pnpm install

Important

Each application has its own README.md for setup and configuration instructions.

Running the Applications

Development Mode

To run ALL the applications in development mode, use the following commands:

pnpm dev  # Runs all apps in development mode

Note

RECOMMENDED: Use the dev command to run all apps in development mode. This ensures that all apps are built and run together, making development easier and faster.

Client (Next.js)

pnpm dev:client  # Runs the Next.js frontend

Server (NestJS)

pnpm dev:server  # Runs the NestJS backend

Deployment

Client

  • Vercel (for excellent integrations with Next.js/Turborepo)

Server

  • Railway (or any other hosting provider)

License

This project is licensed under the MIT License.

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published