Qiskit's website

⚛️ 💻

⚠️ IMPORTANT UPDATE

We renamed the master branch to main and GitHub is displaying a notice for the contributors visiting the repository. However, this is not compatible with the Forking Workflow we follow in the team. If you are contributing to qiskit.org, chances are that you have a fork of this project and your origin remote is pointing to it. The Qiskit/qiskit.org repository should be your upstream remote and so, the instructions provided by GitHub should be directed towards your upstream remote:

git branch -m master main
git fetch upstream
git branch -u upstream/main main

Welcome to Quantum

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

Home page · Learn · Documentation · Advocates · Support: Slack

What’s In This Document

• What’s In This Document
• ⚡️ Live
• 💻 Technology Used
• 🚀 Get Up and Running
• 🏭 Content Generation
• 🧐 Directory structure
• ✏️ How to Contribute
• 🗓 Open backlog
• 👩‍💻 Maintainers

⚡️ Live

Go to Qiskit.org's website

💻 Technology Used

Qiskit.org is a static website generated using Nuxt.

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

With this technology we want to achieve:

• Separation between content edition and development concerns.
• Use a component-based framework like Vue that allow us to reuse part of the UI code in different parts of the application.
• Fast initial page load.
• Index content on Search Engines.
• Test JS unit functions.
• Avoid syntax errors.
• Continuous integration pipeline.

🚀 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

🏭 Content Generation

qiskit.org integrates with the tools used by the IBM Quantum Community Team and generates some 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 Event 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

🧐 Directory structure

We follow Nuxt's directory structure.

✏️ 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

You can see our backlog here.

👩‍💻 Maintainers

In alphabetical order:

Abdón Rodríguez 🐛💻💬	Eddybrando Vásquez 🐛💻💬	Gregorio Iniesta 🐛💻💬	Leron Gil 🐛💬
Randy Tolentino 🐛💻💬	Russell Huffman 🎨💬	Salvador de la Puente 🐛💻💬	Yaiza García 🐛💻💬