Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,78 @@
Resonate Landing Page

[![Figma Design](https://img.shields.io/badge/Figma-Design-%23F24E1E?style=for-the-badge&logo=figma&logoColor=white)](https://www.figma.com/file/b3DxpcvL98arH8Pru0hTEa/Resonate-Landing-Page?type=design&node-id=0%3A1&mode=design&t=IzEKsikv4qAp7jV8-1)

**Resonate - Open Source Real-Time Audio Communication Platform**

---

**Overview**

Resonate is an Open Source alternative to popular social voice platforms like Clubhouse and Twitter Spaces. It empowers the open-source community by providing a credible and user-friendly platform for real-time audio communication. With Resonate, users can join rooms, create and moderate events, engage in pair chatting, and soon enjoy real-time messaging.

---

**Features**

- **Real-Time Audio Communication**: Join rooms and talk to people in real-time.
- **Room Creation and Moderation**: Create rooms, moderate speakers, and organize events.
- **Pair Chatting**: Connect with random partners for engaging conversations.
- **Real-Time Messaging** *(Coming Soon)*: Stay connected with instant messaging.

---

**Installation Guide**

Follow these steps to set up Resonate locally on your system:

1. **Clone the Repository**
```bash
git clone https://github.com/AOSSIE-Org/Resonate-Website.git
```

2. **Navigate to the Project Directory**
```bash
cd Resonate-Website
```

3. **Install Dependencies**
```bash
npm i
```

4. **Start the Application**
```bash
npm start
```

---

**Contributing**

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes and push them to your forked repository.
4. Submit a pull request with a detailed description of your changes.

---

**License**

Resonate is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute it as per the license terms.

---

**Contact**

For any queries or support, feel free to open an issue in the repository or reach out to us via email at [[email protected]](mailto:[email protected]).

---

Thank you for being a part of Resonate!