Giter VIP home page Giter VIP logo

porscheofficial / porscheofficial.github.io Goto Github PK

View Code? Open in Web Editor NEW
17.0 17.0 6.0 82.81 MB

The POSP is a one-stop shop for all open-source activities of Porsche AG and subsidiaries, featuring selected projects and providing documentation on our FOSS best practices.

Home Page: https://opensource.porsche.com

License: MIT License

JavaScript 2.79% TypeScript 42.43% SCSS 10.81% MDX 43.97%

porscheofficial.github.io's Introduction

Porsche Open Source Platform

GitHub GitHub Workflow Status (with event) GitHub Workflow Status (with event) GitHub deployments

The Porsche Open Source Platform (POSP) is a static website generated with Next.js 13 and the Porsche Design System. The POSP is a one-stop shop for all open-source activities of Porsche AG and subsidiaries, featuring selected projects and providing documentation on our FOSS best practices.

๐Ÿ› ๏ธ Run Locally

Clone the project

  git clone https://github.com/porscheofficial/porscheofficial.github.io.git

Go to the project directory

  cd porscheofficial.github.io

Install all dependencies

  yarn install

Start the development server

  yarn dev

๐Ÿ” Testing, Linting and Prettifying

We're using the opinionated ESLint config provided by Porsche Digital. To check your local changes, simply call

yarn test:ci

Check A11y

To ensure the accessibility of the website, we're using dedicated ESLint rules, as well as automated accessibility checks with axe-core.

ESLint runs automatically after each commit via GitHub Action. Locally it can be called via

yarn test:ci

To run axe-core on the deployed website, we're using a dedicated GitHub Action. To run them from local, simply call

yarn playwright:run

Check Lighthouse Performance Score

We have a dedicated GitHub Action to check the Lighthouse Performance Score of the deployed website. Simply call the respective GitHub Action to run the checks.

๐Ÿ Building for Deployment

To locally simulate a production build, simply call

yarn build

To run a production build locally, simply call

yarn start

โœจ Contributing

The Porsche Open Source Platform is openly developed in the wild and contributions (both internal and external) are highly appreciated. See CONTRIBUTING.md on how to get started.

If you have feedback or want to propose a new feature, please open an issue, which will then be monitored/prioritized in our open GitHub Project board.

๐Ÿ™Œ Acknowledgements

This project is a joint initiative of Porsche AG and Porsche Digital.

โœ’๏ธ License

Copyright ยฉ 2023 Dr. Ing. h.c. F. Porsche AG

Dr. Ing. h.c. F. Porsche AG publishes the Porsche Open Source Platform software and accompanied documentation (if any) subject to the terms of the MIT license. All rights not explicitly granted to you under the MIT license remain the sole and exclusive property of Dr. Ing. h.c. F. Porsche AG.

Apart from the software and documentation described above, the texts, images, graphics, animations, video and audio files as well as all other contents on this website are subject to the legal provisions of copyright law and, where applicable, other intellectual property rights. The aforementioned proprietary content of this website may not be duplicated, distributed, reproduced, made publicly accessible or otherwise used without the prior consent of the right holder.

porscheofficial.github.io's People

Contributors

itrich avatar marcelknobelsdorf avatar pboeder avatar switchnollie avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

porscheofficial.github.io's Issues

Refactor automated a11y scans

โœจ Refactor: A11y scans

The A11y scan runs automatically after each push or manually.
That should be changed, because we need to await the deployment process, before running the a11y tests.
Additionally the paths that shall be tested need to be listed in tests/a11y.spec.ts. With the new blog feature, that should be automated, to include the latest blog posts as well.

Acceptance criteria

  • A11y scans should include all deployed paths automatically
  • The A11y scans should be run after each successful deployment

New Feature: Blog

โœจ New Feature: Blog

As member of the FOSS@Porsche community, I want to be able to publish blog posts on the Porsche Open Source Platform, so that I can share interesting background articles on our FOSS activities with our audience. The content of the blog postings may range from interviews with FOSS contributors to tech articles to event summaries.

Acceptance criteria

Given that I have an account on GitHub
When I create a pull request containing a simple Markdown file and optionally further media assets
Then - if the pull request is merged by a POSP maintainer - the content of the Markdown file is rendered on https://opensource.porsche.com/blog/[slugified-title] following a standardized design with the following capabilities:

  • Custom OpenGraph Metadata as defined by the author
  • An "About the author(s)" section with avatars and short biographies of the author(s). This should be maintained independently of the blog post itself (e.g. in our data directory).
  • Display further metadata such as post date, reading time and hashtags/category.

Further requirements

  • Every branch should be deployed by Vercel in order to allow the authors to preview the blog post
  • We should make sure that the OpenGraph metadata is well maintained so that the blog post looks good on all social media platforms
  • We need a post overview under /blog as well as featuring the last x posts on the homepage.
  • If the author did not provide a hero image for his/her blog post, we should fall back to a standard blog post hero image (both for OpenGraph as well as the blog post overview)

Integrate Matomo Analytics

As business owner of the Porsche Open Source Platform, we want to have an insight on how often the website is being accessed and which parts/subpages of the platform are most frequently read.

To achieve this, Matomo shall be integrated in the most privacy-friendly manner and without using any cookies.

Refactor automated lighthouse scans

โœจ Refactor: Lighthouse scans

The Lighthouse scan runs automatically after each push or manually.
That should be changed, because we need to await the deployment process, before running the lighthouse tests.
Additionally, the paths that shall be tested need to be listed in lighthouse.yml. With the new blog feature, that should be automated, to include the latest blog posts as well.

Acceptance criteria

  • Lighthouse scans should include all deployed paths automatically
  • The Lighthouse scans should be run after each successful deployment

Hint

https://github.com/treosh/lighthouse-ci-action#mainyml-7

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.