rach-sharp / starboard

Make your GitHub Stars shine!

Starboard ⭐

Take your GitHub Stars and make them shine. Presents the top GitHub stars as a masonry grid. Authenticate via GitHub and it'll work with your own stars too!

You can access the live site without any setup.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. This was built from the cookiecutter-django template. See the cookiecutter-django deployment with docker for instructions on how to deploy it into production.

Prerequisites

• Python 3.6
• Postgres
• Redis
• Camo Server (Camo is easiest to deploy on Heroku)

Installing

You can follow the instructions on the cookiecutter django site to set up a local development environment, using this codebase rather than a fresh template. Populate a .env file using .example-env as a guide.

You will then need to run python manage.py createsuperuser in order to create an admin to perform Social App setup. Then you can follow the allauth post-install instructions to activate GitHub authentication.

After signing in with a GitHub account, there's a task you can run to pre-populate top repositories without having them be starred by a user.

python manage.py shell

from starboard.stars.tasks import get_top_repos
get_top_repos.delay(<your user pk, 2 if following this guide exactly>)

Built With

• Django - The web framework used
• masonry.js - Used to render the grid of repos.
• PyGithub - Used to access the GitHub API
• camo - Image Proxy to safely hotlink images from GitHub READMEs

Authors

• Rach Sharp

See also the list of contributors who participated in this project.

License

This project is licensed under the GPLv3 License - see the LICENSE file for details

starboard's Issues

Dependabot couldn't authenticate with https://pypi.python.org/simple/

Dependabot couldn't authenticate with https://pypi.python.org/simple/.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Query

@rach-sharp Its not an issue but haven't found any contact so approaching through this way. Do bulb energy have any bug bounty program ?

Thanks