javier / questdb.io

The official QuestDB website, database documentation and blog.

questdb.io

This website is built using Docusaurus 2. Pages & components are written in TypeScript, the styles in vanilla CSS with variables using CSS Modules.

questdb.io

Installation

yarn

Note. On Linux you may have to install autoconf package to have a successful installation. On Ubuntu it should be enough to run sudo apt-get install autoconf command to install the package.

Local development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build for production

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service. For that purpose, you can also use:

yarn serve

Contributing

We are always happy to have contributions to the project whether it is documentation, bug reports, blog posts, or feedback. To get started with contributing:

• Have a look through GitHub issues.
• Read this section for guidelines.
• For blog posts, follow blog guidelines
• Create a fork of questdb.io and submit a pull request with your proposed changes.

Bugs and features

Raise a GH issue for bug report, update request, or tutorial proposal using the respective template.

Guidelines

Check the following guides to ensure that your submission is consistent to our style:

• Markdown guidelines
• Lexicon
• Naming convention
• Code blocks

Commits

The commit messages must follow the Conventional Commits spec.

Templates

To ensure consistency across the document, please follow the templates for:

• Function
• SQL keyword
• Blog

Code Quality

1. Linting

The coding style rules are defined by Prettier and enforced by Eslint

On top of this, we follow the rules set by the JavaScript Standard Style.

You do not need to run the linting task manually, Webpack will take care of that for you.

2. Git Hooks

We use Husky to automatically deploy git hooks.

On every git commit we check that images added to static/img/* do not exceed 10MB.

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.