Skip to content

arashkyadegar/websocket-monorepo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WebSocket Monorepo

Welcome to the WebSocket Monorepo! This repository contains both the server-side and client-side implementations of a WebSocket application using Node.js and React.js, respectively, with TypeScript.

Table of Contents

Introduction

This monorepo is designed to provide a comprehensive example of how to create a WebSocket-based application. The server-side is implemented in Node.js with WebSocket, and the client-side is built using React.js. Both the server and client are written in TypeScript for better type safety and developer experience.

Features

  • Real-time communication using WebSockets
  • Easy-to-understand architecture
  • Fully typed with TypeScript
  • Example of a monorepo structure

Technologies

  • Server: Node.js, WebSocket, TypeScript
  • Client: React.js, TypeScript

Installation

To get started, clone the repository:

git clone https://github.com/your-username/websocket-monorepo.git
cd websocket-monorepo

Server
Navigate to the server directory and install dependencies:
cd server
npm install

Client
Navigate to the client directory and install dependencies:
cd client
npm install


Usage
Running the Server
To start the server, navigate to the server directory and run:

npm build 
and then
npm start 
The server will start on http://localhost:3000.

Running the Client
To start the client, navigate to the client directory and run:

npm run dev

The client will start on http://localhost:3001 and will connect to the WebSocket server.

Contributing
We welcome contributions! Please read our Code of Conduct and Contributing Guide for guidelines on how to get involved.

License
This project is licensed under the MIT License. See the LICENSE file for details.

Code of Conduct
We are committed to fostering a welcoming and inclusive community. Please read our Code of Conduct before participating.

Contact
If you have any questions, feel free to reach out:

Arashk Yadegar

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors