https://github.com/tomtom-international/tomtom-international.github.io

Showcase site for hand-picked open-source projects by TomTom
https://github.com/tomtom-international/tomtom-international.github.io

open-source showcase website

Last synced: about 1 month ago
JSON representation

Showcase site for hand-picked open-source projects by TomTom

• Host: GitHub
• URL: https://github.com/tomtom-international/tomtom-international.github.io
• Owner: tomtom-international
• License: apache-2.0
• Created: 2022-06-04T15:45:52.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-19T00:13:59.000Z (10 months ago)
• Last Synced: 2024-04-16T12:06:41.306Z (9 months ago)
• Topics: open-source, showcase, website
• Language: HTML
• Homepage: https://opensource.tomtom.com
• Size: 435 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# tomtom-international.github.io

[![Nightly Update](https://github.com/tomtom-international/tomtom-international.github.io/actions/workflows/nightly.yml/badge.svg?branch=main)](https://github.com/tomtom-international/tomtom-international.github.io/actions/workflows/nightly.yml)

Showcase site for hand-picked open-source projects by TomTom based on the excellent showcase site built by Spotify. It is built using Jekyll & GitHub Actions with a node.js script to fetch data from the GitHub GraphQL API adding it to a static YAML file in the repository.

This repo is maintained by the TomTom Open Source Program Office.

 

## Development

**Install Jekyll & bundler gems**

```

gem install jekyll bundler

```

**Install yarn**

```

npm install --global yarn

```

**Install dependencies** inside of the project folder

```

yarn & bundle install

```

**Build & serve**

```

bundle exec jekyll serve

```

**(Optional) Test & update data**

[Create a personal GitHub Access Token](https://github.com/settings/tokens) to fetch & update the repository data locally. As the data is updated automatically using GitHub Actions `_data/projects_generated.yaml` should not be added to Git.

```

GH_TOKEN=YOUR_TOKEN node ./scripts/nightly.js

```

## Adding a project to the showcase website

You can add a project by adding it in the `projects.yaml` file.

Find the section for a specific coding language and add the following line to

the `projects:` section: `- url: