Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bestony/neshouse

NESHouse.com —— An open source implementation of ClubHouse
https://github.com/bestony/neshouse

clubhouse hacktoberfest

Last synced: 4 days ago
JSON representation

NESHouse.com —— An open source implementation of ClubHouse

Host: GitHub
URL: https://github.com/bestony/neshouse
Owner: bestony
License: agpl-3.0
Created: 2021-02-03T16:58:05.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2022-07-20T12:39:13.000Z (over 2 years ago)
Last Synced: 2024-11-28T23:42:51.925Z (13 days ago)
Topics: clubhouse, hacktoberfest
Language: JavaScript
Homepage:
Size: 432 KB
Stars: 1,302
Watchers: 36
Forks: 159
Open Issues: 1
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome - NESHouse.com —— An open source implementation of ClubHouse

README

        


[README](readme.md)|[中文介绍](readme.zh.md)

# NESHouse 

An open source implementation of [clubhouse](https://www.joinclubhouse.com/)

NesHouse is a front-end project built on Agora, LeanCloud service, using Alpine.js, Bulma Css, NES.css. This project implements a set of [clubhouse](https://www.joinclubhouse.com/) based on NES style, you can use NESHouse to create your own online live room, you can use NESHouse to create your ostart live room, or share it and invite others to join the discussion.

## NESHouse Pro

If you are interested in the commercial version of NESHouse, further information on NESHouse Pro can be found in [this PDF(Chinese)](https://postimg.aliavv.com/mbp2021/qiqe8.pdf)

## Features

1. multi-chat live room support

2. administrator privileges

3. multiple hosts speaking at the same time

4. audience application to speak

5. administrator ban anchor

6. generate sharing links

## ScreenShots

| Administrator Interface - Chat Room                                                  | Administrator - Create Chat Room                                                  |

| ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- |

| ![Administrator Interface - Chat Room](https://postimg.aliavv.com/mbp2021/l0zr6.jpg) | ![Administrator - Create Chat Room](https://postimg.aliavv.com/mbp2021/uyp2e.png) |

## Demo

- Create Chat Room: https://neshouse.com/admin.html

- Default Page: https://neshouse.com/admin.html

## Demo Flow of use

1. Enter the room name & user nickname in the domain/admin.html to create a new room

2. Click **Log in to chat room as Administrator** below to log in to the room as an administrator

3. Copy the link in the input box and share it with your friends to invite them to join the room.

## Dependency Services

1. [LeanCloud Global](https://console.leancloud.app/)

2. [Agora.io](https://www.agora.io/cn/?utm_source=opensource&utm_medium=refferal&utm_campaign=clubhouseB)

3. （non-essential）[Vercel](https://vercel.com/) 

## How to use

### Flow of use

1. Register a [LeanCloud International Account](https://console.leancloud.app/) and create a project for subsequent project configuration

2. Register an [Agora Sound Network account](https://www.agora.io/cn/?utm_source=opensource&utm_medium=refferal&utm_campaign=clubhouseB) and create a project to get the AppID. **Please select debug mode when creating project, only APPID authentication**

3. Find **AppID** and **AppKey** from LeanCloud's **App Backend** - **Apps you use** - **Settings** - **App Keys**, and record them for later use.

4. Enable **Live Query** from LeanCloud's **App Backend** - **Apps You Use** - **Storage** - **Service Settings**

5. In LeanCloud's **Application Backend** - **Application you use** - **Storage** - **Objects** and create a Class named **RoomUser**.

6. Fill in the application AppID of Agora recorded above and the AppID and APPkey of LeanCloud into the configuration at the top of `js/config.js`.

7. Deploy the modified files to your own server and configure the domain name to point to.

### Configuration file description

**js/config.js**

```js

const AVAPPID = "" // LeanCloud AppID

const AVAPPKEY = "" // LeanCloud AppKey

const AVAPPURL = "" // LeanCloud Custom api domain

const BASEURL = "" // The path where the final page is located, the generated share link will be generated based on this address

const DEFAULT_TEXT = "Please contact [email protected] to Learn more" // Text displayed at the top of the page

const AGORAAPPID = "" // AppID for Agora

```

## Contribute to the project

If you are a user, you can participate in the discussion and ask your questions via [issue](https://github.com/bestony/neshouse/issues) or discussion above

If you are a developer, you can submit your changes directly via [Pull Request](https://github.com/bestony/neshouse/pulls). Note that your changes will be licensed to other developers under the AGPLv3.

## Sponsors

[](https://leancloud.app/)

[](https://www.agora.io/cn/?utm_source=opensource&utm_medium=refferal&utm_campaign=clubhouseB)

## LICENSE 

[AGPLv3](LICENSE)

For commercial use, please contact email [[email protected]]([email protected]) or WeChat `ixiqin_com` for commercial licensing and standalone deployment versions

## Credits

 - [Alpine.js](https://github.com/alpinejs/alpine)

 - [NES.css](https://nostalgic-css.github.io/NES.css/)

 - [Bulma](http://bulma.io/)