coderberry / backyourstack

BackYourStack analyzes repositories to recommend Open Source projects to support.

Discover the open source projects your organization is using that need financial support.

Our goal with BackYourStack is to make it easier for companies to identify the open source projects that they depend on that also need funding.

While we started with just node modules (as defined in package.json files) and with open source projects that are on Open Collective, we know that the open source community is much larger than that. That's why we would love to support more languages and platforms but for that, we need you!

Take a look at our public repository & Contributing Guidelines create or pick up issues and help us make open source more sustainable for everyone! 🙌

Service

The official BackYourStack service is available from https://backyourstack.com/

Development

Prerequisites

Node.js

Make sure you have Node.js version >= 10. We recommend using nvm: nvm install

GitHub API Keys

If you are not working on bugs or features that make use of the GitHub API, you do not need to configure a set of GitHub API keys.

If you are going to work on features that make use of the GitHub API, configuring a set of GitHub API keys will help you avoid issues related to rate limiting. GitHub limits unauthenticated use of their API to 60 requests an hour. Registering a new application and using the API keys provided will enable you to make up to 5000 requests from the GitHub API per hour. You can read more information about how GitHub handles rate limiting in their API Documentation.

To allow authentication with GitHub, you'll need a set of keys for the GitHub API. You can get these keys by registering a new OAuth application with GitHub. By default, the callback URL should be http://localhost:3000/auth/github/callback.

You will need the Client ID and Client Secret provided by GitHub after you register your application.

Install

git clone https://github.com/opencollective/backyourstack.git
cd backyourstack
npm install

Store Your GitHub API Keys

We use dotenv to store environment variables. If you configured a set of GitHub API keys, you will need to save them in a .env file. In the root directory of the repository, rename .env.template to .env and add the Client ID and Client Secret generated when you registered your GitHub application.

Start

npm run dev

This will start your local copy of Back Your Stack. You can access it at http://localhost:3000/

Production

Prerequisite

Now

BackYourStack is currently deployed with Now. You will need to install Now Desktop or Now CLI.

Authenticate with:

now login

Switch to the Open Collective team account:

now switch opencollective

Secrets

Make sure that the following secrets are set (uses now secret):

name	description
github_client_id	Client id for the GitHub oAuth app
github_client_secret	Client secret for the GitHub oAuth app
github_guest_token	GitHub access token used to process unauthenticated requests

Eg: now secret add github_client_id {value}

Deployment

First:

now

If everything is ok, finalize with:

now alias

License

Back Your Stack is made available under the MIT License