Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zeeshanahmad4/slackmate-your-agency-onboarding-assistant
SlackMate simplifies your agency's onboarding process by automating initial greetings, providing step-by-step guidance, and granting access to project tools and channels, all within your Slack workspace." 🌟
https://github.com/zeeshanahmad4/slackmate-your-agency-onboarding-assistant
agency automation bot new-hires onboarding project-management python slack-bot workspace
Last synced: about 2 months ago
JSON representation
SlackMate simplifies your agency's onboarding process by automating initial greetings, providing step-by-step guidance, and granting access to project tools and channels, all within your Slack workspace." 🌟
- Host: GitHub
- URL: https://github.com/zeeshanahmad4/slackmate-your-agency-onboarding-assistant
- Owner: Zeeshanahmad4
- Created: 2023-08-28T10:31:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-04T14:32:46.000Z (over 1 year ago)
- Last Synced: 2023-09-05T04:46:45.083Z (over 1 year ago)
- Topics: agency, automation, bot, new-hires, onboarding, project-management, python, slack-bot, workspace
- Language: Python
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🌟 SlackMate: Your Agency Onboarding Assistant 🌟
[email protected]
┃
@zeeshanahmad4
┃
zee#2655
┃
Zeeshan Ahmad
For discussion, queries, and freelance work. Do reach me.👆👆👆
**Table of Contents**
1. [Project Overview](https://github.com/Zeeshanahmad4/SlackMate-Your-Agency-Onboarding-Assistant#-project-overview)
2. [Features](https://github.com/Zeeshanahmad4/SlackMate-Your-Agency-Onboarding-Assistant#-features)
- [To-Do Features](https://github.com/Zeeshanahmad4/SlackMate-Your-Agency-Onboarding-Assistant#-to-do-features)
4. [Usage Examples](https://github.com/Zeeshanahmad4/SlackMate-Your-Agency-Onboarding-Assistant#-usage-examples)
- [Setup and Installation](https://github.com/Zeeshanahmad4/SlackMate-Your-Agency-Onboarding-Assistant#-setup-and-installation)
6. [Troubleshooting Tips](https://github.com/Zeeshanahmad4/SlackMate-Your-Agency-Onboarding-Assistant#-troubleshooting-tips)
7. [Contribution Guidelines](https://github.com/Zeeshanahmad4/SlackMate-Your-Agency-Onboarding-Assistant#-contribution-guidelines)
## 📚 Project Overview
SlackMate is your go-to Slack bot designed to streamline the onboarding process for new hires in an agency setting. This bot takes care of everything from sending a warm welcome message to guiding new team members through the essential steps they need to become a full-fledged member of your workspace. 🎉
## 🚀 Features
- **Initial Greeting**: Sends a friendly welcome message as soon as a new member joins the Slack workspace.
- **Onboarding Guidance**: Provides step-by-step guidance complete with tutorials, FAQs, and other essential documentation.
- **Project Management Tools Access**: Gives access or instructions for tools like Jira, Asana, and Trello.
- **Sharing Relevant Information**: Shares essential links such as code repositories and documentation.
- **Channel Access**: Automatically grants access to relevant Slack channels based on the member's role.
### 🌟 To-Do Features
- **Automated Surveys**: Collect feedback on the onboarding process.
- **Checklist Tracking**: Track the completion of onboarding tasks.
- **Role-based Customization**: Customize the onboarding process based on the department or role.
## 🎯 Usage Examples
Run the bot by executing the main.py script. It will listen for events and respond accordingly.
python src/main.py
## 🔧 Setup and Installation
1. **Clone the Repository**
bashCopy code
`git clone https://github.com/yourusername/SlackMate.git`
2. **Navigate to Project Directory**
bashCopy code
`cd SlackMate`
3. **Install Dependencies**
bashCopy code
`pip install -r requirements.txt`
4. **Set Environment Variables**
Add your Slack API token to the environment variables or in `config/settings.json`.
5. **Run the Bot**
bashCopy code
`python src/main.py`
---
## 🛠 Troubleshooting Tips
- **API Token Issues**: Make sure the API token is correctly set in the environment variables.
- **Dependency Errors**: Ensure all dependencies are properly installed from `requirements.txt`.
- **Permission Issues**: The bot requires specific permissions in your Slack workspace. Make sure they are granted.
---
## 🤝 Contribution Guidelines
1. **Fork the Repository**: Create your own fork of the repository.
2. **Clone to Local Machine**: Clone your forked repository to your machine.
3. **Create a New Branch**: Always create a new branch for your changes.
4. **Commit Changes**: Commit any changes you've made.
5. **Push to GitHub**: Push the committed changes to GitHub.
6. **Create a Pull Request**: Create a pull request from your fork to the original repository.