OpenWChat-Server

The express ts server for the OpenWChat app.

View Demo . Report Bug . Request Feature

About The Project

OpenWChat-server is the backend repository powering the OpenWChat app, a WhatsApp clone developed using Express.js, TypeScript, Socket.IO, and MongoDB. This server facilitates real-time communication, user authentication, and data storage for the OpenWChat application, providing a robust foundation for building a feature-rich and secure messaging platform.

Built With

• Express.js: A fast and minimalist web framework for Node.js.
• TypeScript: A statically typed superset of JavaScript that enhances code maintainability and scalability.
• Socket.IO: Real-time bidirectional event-based communication for enabling instant messaging features.
• MongoDB: A NoSQL database for efficient and scalable data storage.
• Docker: A platform for developing, shipping, and running applications in containers.

Getting Started

Follow these steps to get a local copy up and running:

Installation

1. Clone the repository:

git clone https://github.com/OpenWChat/OpenWChat-server.git

Running locally

Without docker

1. Provide environment variables based on the .env.example file.
2. Install dependencies:

npm install

3. Run the development server:

npm run dev

With docker

1. Provide environment variables based on the .env.example file.
2. Make sure Docker is installed and running on your system.
3. Run the following command to start both the server and RTMP microservice using Docker Compose:

docker-compose up app

Contributing

We welcome contributions from the community to enhance OpenWChat. If you'd like to contribute, please follow these guidelines:

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. State your Changes (npm run clean)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Authors

• Mahdi EttehadNejad - AI & Backend developer - Mahdi EttehadNejad - Built the server