Unblock Me

Get Help Now. Reach Out to a mentor using UnblockMe, A Github bot
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Unblockme is a Github bot. With unblockme, an MLH fellow can request technical assistance and schedule a meeting with a mentor. How? By creating an issue on a repository and bam!--all set. The MLH mentor gets better context of the challenge the MLH fellow is experiencing. You begin the ask right from the repository before the meeting. All a fellow needs to schedule a meeting is to create an issue on the repository.

Here's why unblockme is helpful:

• A fellow can quickly request technical assistance on a blocker.
• A mentor gets a better context of the blocker. How? By getting information on the blocker, repository, with the file number inclusive.
• 😄 Yep, unblockme puts a smile on the faces of mentors and fellows

A list of other used resources that were used are listed in the acknowledgments.

Built With

This section lists any major frameworks that the project was built using.

• React
• Probot
• Google Calendar
• Firebase
• Email Service

Getting Started

This is how you can set up the project. To get a local copy up and running follow these steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Node
• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/build-demo/unblockme.git

2. Install NPM packages

   npm install

3. Create and register a Github application here
4. Get the APP ID From the Github Application registered
5. Create .env file and copy the values of .env.sample into it

    # The ID of your GitHub App
    APP_ID=
    WEBHOOK_SECRET=

    # Use `trace` to get verbose logging or `info` to show less
    LOG_LEVEL=debug

    # Go to https://smee.io/new set this to the URL that you are redirected to.
    WEBHOOK_PROXY_URL=

    # Email
    EMAIL_SERVICE=gmail
    EMAIL_USER=
    EMAIL_PASS=

6. Run the bot

   npm start

Debugging

• Always run $ npm install and restart the server if package.json has changed.
• To turn on verbose logging, start the server by running: $ LOG_LEVEL=trace npm start

Usage

Install the app on a repository or an organization

1, Follow through with the steps and choose which repositories you will like to install unblock me on.

• https://github.com/apps/unblock-me

2. Create an issue on the repository with the label Help Wanted the following information in the body

#Blocker Details

Mentor assist=true
Name=Name of Fellow
Email=example@example.com
Description=I need help with this project ...
Programming Language=Language
Filename (optional)
line number(optional)

Roadmap

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

Contributing

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

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• @jakazzy
• @Adesin
• @ridhambat

Project Link: https://github.com/build-demo/unblockme

Acknowledgements

• mailgene

License

ISC © 2021 unblockme unblockme.tech@gmail.com

A GitHub App built with Probot