Commonroom

Commonroom is an ephemeral chatroom for strangers
The Origins of Commonroom »

Visit Site · Report Bug · Request Feature

Table of Contents

1. About Commonroom
   • Built With
2. Getting Started
   • Installation
3. Team
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About Commonroom

Commonroom is an ephemeral text based chat application that revives the essence of fleeting, meaningful interactions reminiscent of hostel common rooms. It's a digital space where individuals can come together as a small group, hangout and share experiences, albeit briefly.

For context the application was originally built by TEJI aka Jet Williams, inspired by his travels around the world he wanted to replicate his experiances staying in hostels and hanging out with other travelers in an online space. Commonroom's core feature is the time limited chatrooms with small groups of strangers which self destruct at random intervals.

At Commonroom, we cherish your privacy as much as you do. All chats are ephemeral, disappearing after the session ends, leaving no digital footprint behind. Embrace the freedom of unburdened conversations; no data, no traces, just genuine interactions.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

This section outlines how to set up Commonroom locally. By following these instructions, you'll have a local copy of the project up and running on your machine.

Installation

1. Install Node.js and npm: Node.js is the runtime environment required to run JavaScript on the server side, and npm is a package manager for JavaScript. Install them from the Node.js official website.

2. Clone the repository:

   git clone https://github.com/tejitopia/commonroom.git

3. Navigate to the project directory:

   cd commonroom

4. Install NPM packages: This will install all the dependencies, including Express.js and Socket.io, needed for Commonroom.

   npm install

(back to top)

Team

Founder & CEO - TEJI

Co-Founder & CTO - Alen Velocity

(back to top)

Roadmap

• Refactor Script.js
• Migrate to React
• Topic Specific Rooms
• Moderation Tools
• Darkmode
• Mini Games
• Mobile App

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make Commonroom better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give Commonroom a star! Thanks again!

Contribution Workflow

Here's how we suggest you go about proposing a change to Commonroom:

1. Fork the Project: Start by forking the repository and then clone it locally.
2. Create your Branch: For new features and non-urgent bug fixes, branch off develop.
   • For features: git checkout -b feature/YourAmazingFeature develop
   • For bug fixes: git checkout -b bugfix/YourBugFix develop
   • For urgent hotfixes needed on master: git checkout -b hotfix/YourHotfix master
3. Commit your Changes: Commit your changes with a clear and descriptive message.
   • Example: git commit -m 'Add some AmazingFeature'
4. Push to Your Fork: Push your changes to your fork.
   • Example: git push origin feature/YourAmazingFeature
5. Open a Pull Request: Go to our repo and open a pull request from your feature, bugfix, or hotfix branch to the appropriate branch on the main repository.
   • For features and bug fixes, target the develop branch.
   • For hotfixes, target the master branch.
6. Code Review: Wait for the code review and address any feedback.

Before Submitting

Before submitting your pull request, please ensure the following:

• Your code follows Commonroom's style and contribution guidelines.
• Your changes are well-documented and include any necessary updates to documentation.
• You've tested your changes thoroughly.

Pull Request Process

Once you've submitted your pull request, we will review your code. We may suggest changes, improvements, or ask for further clarification. This is a big part of how open source works, so don't be discouraged! This feedback loop is valuable and helps everyone learn and improve.

Once your pull request is approved and merged, your contributions will be publicly acknowledged.

Thank you for your contributions, and we look forward to seeing your innovative and fantastic work!

(back to top)

License

Distributed under the GNU General Public License v3.0. See LICENSE.txt for more information.

(back to top)

Contact

TEJI - @TEJITOPIA - hello@tejitopia.com

Alen - @AlenVelocity

(back to top)

Acknowledgments

• Thank you to my mum & dad for the endless love and support
• Thank you to The Internet for providing us with free resources to learn how to create anything we want
• Thank you to all the contributers who make building projects like this possible

(back to top)