Giter VIP home page Giter VIP logo

scope's Introduction

Scope - Serverless Open Source Status Board

Scope is a customizable bird's eye view of your Github project.

It automatically pulls in issues & Pull requests and sorts them into columns you define. Think github projects on steroids.

Built using event driven serverless tech, the application can be cloned down, configured, & deployed for your project in minutes.

Deploy it as a stand-alone application or embed it directly into your project's site.

Run it for free under AWS's generous free tier.

Table of Contents

Click to expand

Features

  • Customize the labels/columns to fit your project
  • Customizable styles ๐Ÿ’
  • Driven by push based Github webhooks
  • Run as standalone app or Embed on your project's site
  • Look mom! No servers!

Data automatically updates when activity happens in your repository and your status board will reflect the latest state of your project.

Why we built it

We built this tool for our community to help keep people up to speed with what is happening with the serverless project & to highlight places where we actively want feedback + collaboration.

  • Quickly sort and see high priority issues & Pull requests
  • Call out which issues need attention from your community
  • Zoom into important aspect of your open source project

Front-end Documentation & setup

Backend Documentation & setup

Video Tutorials

Contributing

Want to contribute back to the project? Drop an issue or open up a PR.

Setup

First things first ๐Ÿ‘‰ Setup your AWS account and npm i serverless -g to be able to deploy your status board

  1. Deploy the serverless Backend. Follow these instructions

  2. Grab your API endpoints & plug them into the front-end in /frontend/src/custom.config.js

  3. Configure the front-end columns with your projects labels, build and deploy it. Follow these instructions

FAQ

Do I need an AWS account for this to work?

Yes, but this will fall into the free tier of an AWS account. Free tier Signup

Does it need to show all my issues?

Nope. You choose what labels show up in each column

Do I have to show recently completed items?

Nope. You can toggle off that column in the front-end config.

I just setup the front-end, where are the recently completed items?

They will start flowing in once you start closing issues/PRs in your repo


Website โ€ข Email Updates โ€ข Gitter โ€ข Forum โ€ข Meetups โ€ข Twitter โ€ข Facebook โ€ข Contact Us

scope's People

Contributors

danpalmer avatar davidwells avatar laardee avatar mzmiric5 avatar quantuminformation avatar

Stargazers

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

Watchers

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

scope's Issues

drag+drop in frontend

This is a conceptual question.

Do you see this project going into a direction of waffle.io or github projects in terms of write access in the frontend? Or do you want to keep it as a read-only dashboard?

Replace dynamodb with S3

Would it be an option to replace dynamodb with s3?

You can use the list command in s3 to get something similar to scan. This would mean you could open the bucket to be read directly from the client reducing the need for lambda and costs.

You can use a bucket policy similar to this

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AddPerm",
            "Effect": "Allow",
            "Principal": "*",
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::Example/*"
        },
        {
            "Sid": "AddPerm",
            "Effect": "Allow",
            "Principal": "*",
            "Action": "s3:ListBucket",
            "Resource": "arn:aws:s3:::Example"
        }
    ]
}

Did an initial bit of work to show how this might be done master...andymac4182:master

what

am i not understanding this correctly or what
the title says serverless
and this requires a server lol
this might just be a coincidence cuz the repo owner's name is serverless
just thought to share

Minor backend install sequence error: npm install

Minor thing, but the backend instructions don't explicitly tell you to run npm install but instead jump straight to the config file editing. If you don't run npm install, the setup script fails:

$ sls invoke -f setup
{
"errorMessage": "Cannot find module 'sync-request'",
"errorType": "Error",
"stackTrace": [
"Module.require (module.js:353:17)",
"require (internal/module.js:12:17)",
"Object. (/var/task/lib/setup.js:4:21)",
"Module._compile (module.js:409:26)",
"Object.Module._extensions..js (module.js:416:10)",
"Module.load (module.js:343:32)",
"Function.Module._load (module.js:300:12)",
"Module.require (module.js:353:17)"
]
}

But that's fixed if you run npm install, redeploy, and try the setup again.

package exclude is ignored on 1.16.1

Hi,
I have an exclude statement very similar to your documentation in my yaml file. On 1.16.1 it is ignored, but rolling back to 1.15 solved it.

Thanks,
Oren

New to react.js -- greyish black screen

A noob to react.js,-- Install all dependencies using npm on Ubuntu 18.04. Reports 5 vulnerabilities, 1 requiring manual fixing, 3 updates for 4 vulnerabilities will break things. Change repo name to mine in default.config.js

Launch dev server using custom.config.js (my endpoints) and I get a blank black grey page and the serverless logo on my browser tab. TIA for any insights.

npm --version 6.5.0
node.js --version 8.15.0

[question] invoke setup function gives Bad credentials error

I tried to run the setup function, do I need to create an API token?

image

backend git:(master) โœ— sil setup

  Error --------------------------------------------------

     Server responded with status code 401:
{"message":"Bad
     credentials","documentation_url":"https://developer.github.com/v3"}

     For debugging logs, run again after setting the "SLS_DEBUG=*" environment variable.

  Get Support --------------------------------------------
     Docs:          docs.serverless.com
     Bugs:          github.com/serverless/serverless/issues

     Please report this error. We think it might be a bug.

  Your Environment Information -----------------------------
     OS:                 darwin
     Node Version:       6.9.1
     Serverless Version: 1.7.0

Organisation level

It would be great if this could be pointed at a Github Organisation to allow for summarising and working on issues across repos.

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.