46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
|
|
|
## Installation
|
|
|
|
```console
|
|
npm install
|
|
```
|
|
|
|
## Local Development
|
|
|
|
```console
|
|
npm run dev
|
|
```
|
|
|
|
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
|
|
|
## Build
|
|
|
|
```console
|
|
npm run build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
## Deployment
|
|
|
|
This website is deployed on render.com
|
|
|
|
## Contributing
|
|
|
|
Thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody and are appreciated.
|
|
|
|
Please try to create bug reports that are:
|
|
|
|
- _Reproducible._ Include steps to reproduce the problem.
|
|
- _Specific._ Include as much detail as possible: which version, what environment, etc.
|
|
- _Unique._ Do not duplicate existing opened issues.
|
|
- _Scoped to a Single Bug._ One bug per report.
|
|
|
|
## Community
|
|
|
|
- [Discord](https://discord.gg/uyb7pYt4Pa) (For live discussion with the Community and BoxyHQ team)
|
|
- [Twitter](https://twitter.com/BoxyHQ) (Get the news fast)
|