Skip to content

Latest commit

 

History

History
81 lines (48 loc) · 2.78 KB

README.md

File metadata and controls

81 lines (48 loc) · 2.78 KB
Raw

eac

EchoAtrium Community Frontend (EAC)

Welcome to the official repository for the EchoAtrium Community Frontend (EAC), a dynamic and user-friendly interface designed to enhance communication and collaboration within the EchoAtrium community. This platform is built with a focus on real-time interactions, offering features like peer-to-peer video and audio calls, as well as voice chat rooms.

Features

EAC brings a suite of interactive features to the EchoAtrium community:

  • Peer-to-Peer Video Calls: Connect with community members through high-quality video calls.
  • Audio Calls: Opt for audio-only calls for a more bandwidth-friendly option.
  • Voice Chat Rooms: Join or create voice chat rooms for group discussions or casual conversations.

Tech Stack

This project is built using a robust and modern tech stack, ensuring a seamless user experience and easy maintainability:

  • React: A JavaScript library for building user interfaces, known for its efficiency and flexibility.
  • TailwindCSS: A utility-first CSS framework for rapidly building custom designs.
  • WebRTC: An open-source project that provides web browsers and mobile applications with real-time communication capabilities.

Getting Started

To get started with EAC, follow these steps:

Prerequisites

Ensure you have the following installed:

  • Node.js (latest stable version)
  • npm (comes with Node.js)

Installation

  1. Clone the Repository

    git clone https://github.com/your-username/echoatrium-community-frontend.git
cd echoatrium-community-frontend

  2. Install Dependencies

    npm install

  3. Run the Application

    npm start

    This will run the app in development mode. Open http://localhost:3000 to view it in your browser.

Contributing

We welcome contributions to the EchoAtrium Community Frontend! If you have suggestions for how to improve the app, or if you want to report a bug, please open an issue. For larger changes, please open a pull request with a clear description of the changes.

Guidelines

  • Ensure your code adheres to the existing style for consistency.
  • Update the documentation, if necessary.
  • Write and run tests to confirm your changes work as expected.

Support

If you encounter any problems or have questions, feel free to reach out to the community or maintainers for assistance.

License

This project is licensed under the Creative Commons Attribution-NonCommercial (CC BY-NC) License - see the LICENSE file for details.

Please note that this project is available for non-commercial use only. Commercial use is strictly prohibited under this license.

Thank you for being a part of the EchoAtrium community and contributing to the EAC project! 🌟