https://github.com/crusher-dev/documentation
https://github.com/crusher-dev/documentation
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/crusher-dev/documentation
- Owner: crusher-dev
- License: apache-2.0
- Created: 2020-08-21T15:22:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-22T04:23:00.000Z (over 5 years ago)
- Last Synced: 2025-04-04T01:29:41.862Z (about 1 year ago)
- Language: TypeScript
- Size: 59.8 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](http://standardjs.com)
[](https://github.com/prettier/prettier)
[](https://conventionalcommits.org)
# questdb.io
[This website](https://questdb.io) is built using
[Docusaurus 2](https://v2.docusaurus.io/). Pages & components are written in
TypeScript, the styles in vanilla CSS with variables using
[CSS Modules](https://github.com/css-modules/css-modules).
## Installation
```script
yarn
```
## Local development
```script
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
```script
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:
```script
yarn serve
```
# Contributing
Feel free to contribute to the project by forking the repository and submitting
pull requests.
## Guidelines
Consult the
[guidelines](https://github.com/questdb/questdb.io/blob/master/docs/__guidelines/markdown.md).
## Lexicon
Consult the
[lexicon](https://github.com/questdb/questdb.io/blob/master/docs/__guidelines/lexicon.md)
for terminology we commonly use
## Commits
The commit messages must follow the
[Conventional Commits](https://conventionalcommits.org/) spec.
# Code Quality
## 1. Linting
The coding style rules are defined by [Prettier](https://prettier.io/) and
enforced by [Eslint](https://eslint.org)
On top of this, we follow the rules set by the
[JavaScript Standard Style](https://standardjs.com/rules.html).
You do not need to run the linting task manually, Webpack will take care of that
for you.
## 2. Git Hooks
We use [Husky](https://github.com/typicode/husky) to automatically deploy git
hooks.
On every `git commit` we check that images added to `static/img/*` do not exceed
10MB.