HangBuddies

A fast, shareable, registration-free tool for gathering preferences and picking dates with customizable options.

Table of Contents

• Features
• Contributing
  • Prerequisites
    • Dependencies
    • Tools
  • Installation
  • Configuration
  • Live Previews
    • Staging (Pre-Production)
    • Development (Pre-Staging/active development)
• License
• Acknowledgements
  • Contributors

Features

• Event Polls: Create and share event polls effortlessly.
• No Registration: Creators and participants can vote without an account.
• Customizable Options: Define time slots, add descriptions, and set preferences.
• Responsive UI: Works across devices for easy access.

Contributing

Important

This project is still in initial development, and we are working on setting up configuration for contributors.

Contributions are welcome! Please read the contribution guidelines and other relevant documents for developers before getting started.

Prerequisites

Dependencies

We use multiple tools to build HangBuddies. The following are the minimum requirements to get started:

• Node.js: Version ^20 or higher
  • npm: Version ^10 or higher
  • pnpm
  • yarn
• Angular CLI: For building and running the frontend
• NestJS CLI: For building and running the backend

Tools

• Bruno: Free and open-source API client (find useful collections in bruno/)
• Docker: For running the backend locally
• NVM: For managing Node.js versions (https://github.com/nvm-sh/nvm)

Installation

Collaborators can clone this original repository, as a contributor you should make a fork onto your account.

git clone https://github.com/danieljancar/hangbuddies.git
cd hangbuddies
# Node > 20
npm run install:all # Install all dependencies in the project (submodules)

Important

Make sure you run npm run install:all (Node > 20) at root before doing any work, so all tools and hooks are working.

Configuration

Note

As already mentioned, we are working on setting up configuration for contributors. Please check back later.

Live Previews

We have multiple live previews of different environments. You can find them in the following links:

Staging (Pre-Production)

• Frontend: https://stage.hangbuddies.com
• Backend: https://api-stage.hangbuddies.com

Development (Pre-Staging/active development)

• Frontend: https://dev.hangbuddies.com
• Backend: https://api-dev.hangbuddies.com

Note

The environments above are hosting the latest staging and develop branches. The staging branch is the latest pre-stable version of the application, while the develop branch is the latest development version. They are seeded with test data and are not meant for production use.

License

This project is licensed under MIT License. By contributing to HangBuddies, you agree that your contributions will be licensed under the same license. Also, you agree to the Contributor Covenant Code of Conduct and the Developer Certificate of Origin.

Acknowledgements

Contributors

Thanks to the following people for their contributions:

Released under the MIT License by @danieljancar.