Giter VIP home page Giter VIP logo

rudolph's Introduction

Rudolph

Swift Version Heroku License

Giving gp to Hack Clubbers who contribute to open source!

🏖 The flow:

  1. Post a message to scrapbook and react with the special emoji (rudolph)
  2. Rudolph runs some basic checks on, to make sure they aren't spam Pull Requests
  3. The total amount of gp you earn is calculated which is 15gp plus any events that the PR is eligible for
  4. That is submitted to the review channel to be checked to see if it is a spam PR
  5. Your gp is given to you by the friendly bankerapi bot!

⚙️ Setup:

  1. Install Swift: https://swift.org/download/#releases It's available for OS X/Windows/Linux and the toolchain doesn't take up too much space.
  2. You also need to have vapor installed: brew install vapor on OS X, or install it for Linux.
  3. To use the database, you need to also need to install postgres: brew install postgres and make a user called "rudolph". There's no password.
  4. Finally, you need to have the slack bot set up:
  • It needs the scopes:
    • channel:read
    • channel:history
    • chat:write
    • reactions:read
  • Set the events api up, pointing it at https://[YOUR SERVER].com/slack/events
    • The only event subscription it needs is the reactions_read.
  1. Finally, finally, you need to fill in all the information in .env.example. To check that it can build, you can just fill it with nonsense, but, of course, it won't run/talk with slack.

rudolph's People

Contributors

sarthaktexas avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar

rudolph's Issues

Pull Request Checks

  • Add a Check protocol, like the events protocol
    Checks for the PRs:
  • The PR is valid
  • Has been merged
  • Not been marked as spam/invalid
  • Verify pr has not been used before
  • the repo owner and the Pr'er person are different

Interface with banker bot

Once the Pull request is approved or rejected, send a message through banker api, with the gp, if necessary.

New Emoji

We should get a custom emoji made: something with gp, Christmas, Santa, reindeers? Just random ideas.

Respond to verification

If the verification message is reacted on with a ✅ then approve the request, and send the cash through banker bot. If it's reacted with a 🚫 then send a message through banker bot that it couldn't be approved.

Do Heroku Stuff

Finish up some Heroku stuff:

  • Set up the env variables
  • Turn off debug mode (It might already be off)
  • Set it to the slack bot
  • Change/add the database
  • run migrations for the database
  • transfer to linus' account
  • Move to swift 5.3
  • Remove docker stuff because I don't think we need it
  • Build for production: https://github.com/swift-server/guides#building-for-production

More as I think of it...

Middle Flow

Verify that the Pull request is good, calculate if it's eligible for any events, and posting for review.

Events api

We need to have an events api: Listening for reactions being added in the scrapbook and review channels
It should verify the request is from slack.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.