Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/serverless/scope

🔭 Scope - Create a birdeye's view of your Github project and embed on your site
https://github.com/serverless/scope

aws-lambda dynamodb github serverless webhooks

Last synced: about 18 hours ago
JSON representation

🔭 Scope - Create a birdeye's view of your Github project and embed on your site

Awesome Lists containing this project

README 

        


  




# 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](https://aws.amazon.com/free/)** under AWS's generous free tier.



## Table of Contents



Click to expand



- [Features](#features)

- [Why we built it](#why-we-built-it)

- [Contributing](#contributing)

- [Setup](#setup)

- [FAQ](#faq)



## 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](./frontend/README.md)



[Backend Documentation & setup](./backend/README.md)



[Video Tutorials](https://www.youtube.com/playlist?list=PLIIjEI2fYC-BtxWcDeTziRp7cIZVEepB3)



# Contributing



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



## Setup



**First things first** 👉 [Setup your AWS account](https://youtu.be/HSd9uYj2LJA) and `npm i serverless -g` to be able to deploy your status board



1. Deploy the serverless Backend. [Follow these instructions](./backend/README.md)



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](./frontend/README.md)



## 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](https://aws.amazon.com/free/)



**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](http://www.serverless.com) • [Email Updates](http://eepurl.com/b8dv4P) • [Gitter](https://gitter.im/serverless/serverless) • [Forum](http://forum.serverless.com) • [Meetups](https://github.com/serverless-meetups/main) • [Twitter](https://twitter.com/goserverless) • [Facebook](https://www.facebook.com/serverless) • [Contact Us](mailto:[email protected])