Overview:
The Spotify Showcase site is a platform for curated open-source projects chosen by Spotify. Developed using Jekyll, GitHub Actions, and a Node.js script for integration with the GitHub GraphQL API, it maintains a static YAML file of project data within the repository.
Features:
- Hand-Picked Projects: Spotify selects and presents open-source projects on the showcase site.
- Built with Jekyll & GitHub Actions: Utilizes Jekyll for the site structure and GitHub Actions for automated updates.
- Data Integration: Node.js script fetches project details from the GitHub GraphQL API to update the YAML file.
- Development Guidelines: Provides clear instructions for installing necessary gems, dependencies, and setting up the project.
Installation:
To install the Spotify Showcase site, follow these steps:
- Install Jekyll and bundler gems:
gem install jekyll bundler
- Install yarn:
npm install --global yarn
- Install dependencies in the project folder:
yarn install
- Build and serve the project:
bundle exec jekyll serve
- (Optional) Test and update data.
- Create a personal GitHub Access Token to fetch and update data locally. Note that the
_data/projects_generated.yamlfile should not be added to Git.
Summary:
The Spotify Showcase site is a curated platform for open-source projects, showcasing Spotify’s selected projects through Jekyll, GitHub Actions, and a Node.js script integration with the GitHub GraphQL API. By following the installation guide and development instructions, users can explore and contribute to this collection of hand-picked projects while adhering to the Open Code of Conduct.