Eric-Arellano / qiskit.org

The Qiskit official website

Home Page:https://qiskit.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Qiskit

Welcome to Qiskit.org

Qiskit is an open-source quantum computing software development framework for leveraging today's quantum processors in research, education, and business.

Qiskit.org is released under the Apache 2.0 License. Current GitHub Action build status. PRs welcome! Follow @qiskit

Home page · Learn · Events · Advocates · Ecosystem · Documentation · Providers


Table of Contents


🚀 Get Up and Running

  1. Download this repository and go to its folder

    git clone git@github.com:Qiskit/qiskit.org.git && cd qiskit.org
  2. Install dependencies

     npm install
  3. Run a local server with hot reload at localhost:3000

    npm run dev

💻 Technology Used

Qiskit.org is a static website generated using Nuxt.

We create and run tests using Vitest, avoid syntax errors using ESLint and Stylelint, and automate code integration and deployment using GitHub Actions.


🏭 Content Generation

Qiskit.org integrates with the tools used by the IBM Quantum Community Team to generate content based on 3rd party APIs such as Airtable. Part of this content is prefetched during building time. While developing, it is disabled by default. If you want enable content generation, you must set the environment variable GENERATE_CONTENT. For instance:

GENERATE_CONTENT=1 npm run dev

Notice that, for communicating with the team tools, API keys may be required. It is the case of dealing with Airtable for the generation of the event index. If you think you should have access to these tables, talk to the Events Squad in the Community Team, get your developer API key and set the AIRTABLE_API_KEY environment variable to this value:

GENERATE_CONTENT=1 AIRTABLE_API_KEY=<your airtable api key> npm run dev

✏️ How to Contribute

Contributions are always welcomed, no matter how large or small. Before contributing, please read the contributing guide and code of conduct.


🗓 Open backlog

We actively maintain our backlog using GitHub Projects. You can view our backlog here.


👩‍💻 Maintainers

Eddybrando Vásquez
Eddybrando Vásquez

🐛💻💬
Randy Tolentino
Randy Tolentino

🐛💻💬
Randy Tolentino
Russell Huffman

🎨💬
Yaiza García
Yaiza García

🐛💻💬

🔗 Connect with Qiskit

About

The Qiskit official website

https://qiskit.org

License:Apache License 2.0


Languages

Language:Vue 79.0%Language:TypeScript 19.2%Language:SCSS 1.4%Language:HTML 0.2%Language:JavaScript 0.1%Language:Shell 0.1%Language:Dockerfile 0.0%