Skip to content

README.md

Latest commit

 

History

History
88 lines (67 loc) · 4.1 KB

README.md

File metadata and controls

88 lines (67 loc) · 4.1 KB

Time off App

The TimeOffApp for Rocket.Chat helps teams stay informed and organized by managing user availability during time off. It automatically notifies colleagues in direct messages when a recipient is unavailable, displaying a personalized message left by the user. This ensures clear communication and minimizes disruptions in the workflow.

Features 🚀

  • Set Time Off Status: Users can easily set their availability status and leave a personalized message for their colleagues during their time off.
  • Automatic Notifications: When someone sends a direct message to a user who is unavailable, they are automatically notified with the custom message left by the recipient.
  • Seamless Integration: Works effortlessly within Rocket.Chat, ensuring smooth communication without requiring additional tools.
  • Enhanced Team Coordination: Helps teams stay informed about each other's availability, reducing misunderstandings and improving collaboration.

How to Set Up 💻

  1. Ensure you have a Rocket.Chat server ready. If you don't have one, follow this guide.
  2. Install the Rocket.Chat Apps Engine CLI: 
    npm install -g @rocket.chat/apps-cli

    Verify the CLI installation:

    rc-apps -v
# Example output: @rocket.chat/apps-cli/1.12.0 darwin-arm64 node-v22.11.0
  3. Clone the GitHub repository:
    4. git clone https://github.com/RocketChat/Apps.TimeOff.git
  4. Navigate to the repository:
    5. cd Apps.TimeOff
  5. Install the app dependencies:
    6. cd app && npm install
  6. Enable development mode on your Rocket.Chat server. Go to Administration > General > Apps and toggle "Enable development mode" to ON.
  7. Deploy the app to your server:
    8. rc-apps deploy --url <server_url> --username <username> --password <password>
    • If running the server locally, server_url is typically http://localhost:3000. Adjust the port if necessary.
    • Replace <username> with your admin username.
    • Replace <password> with your admin password.
  8. Open the app by navigating to Administration > Marketplace > Private Apps. You should see the app listed there. Click on the app name to open it and verify that it is enabled.

How to Use 💬

Once the app is installed and enabled, you can use the following commands to manage your time-off status:

  • /time-off start [message]: Start a new time-off period and optionally include a custom message. This will notify others who send you direct messages.
  • /time-off end: End your current time-off period. This will clear your status and stop notifying others that you are unavailable.
  • /time-off status: Check your current time-off status to see if you are marked as unavailable.
  • /time-off help: Display a help message with details about all available commands.

These commands make it easy to manage your availability and keep your team informed.

🧑‍💻 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 this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feat/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: adds some amazing feature')
  4. Push to the Branch (git push origin feat/AmazingFeature)
  5. Open a Pull Request

Support us ❤️

If you like this project, please leave a star ⭐️. This helps more people to know this project.