Porsche Open Source Platform

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.