2023-07-05 14:43:25 +08:00
# Website
2023-03-14 16:11:30 +08:00
2023-07-05 14:43:25 +08:00
This website is built using [Docusaurus 2 ](https://docusaurus.io/ ), a modern static website generator.
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
## Installation
2023-03-14 16:11:30 +08:00
2023-07-05 14:43:25 +08:00
```console
npm install
2023-03-14 16:11:30 +08:00
```
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
## Local Development
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
```console
npm run dev
```
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
## Build
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
```console
npm run build
```
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
## Deployment
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
This website is deployed on render.com
2023-03-15 16:04:51 +08:00
2023-07-05 14:43:25 +08:00
## Contributing
2023-03-30 15:33:17 +08:00
2023-07-05 14:43:25 +08:00
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.
2023-03-14 16:11:30 +08:00
2023-07-05 14:43:25 +08:00
Please try to create bug reports that are:
2023-03-30 15:33:17 +08:00
2023-07-05 14:43:25 +08:00
- _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.
2023-03-30 15:33:17 +08:00
2023-07-05 14:43:25 +08:00
## Community
2023-03-14 15:36:27 +08:00
2023-07-05 14:43:25 +08:00
- [Discord ](https://discord.gg/uyb7pYt4Pa ) (For live discussion with the Community and BoxyHQ team)
- [Twitter ](https://twitter.com/BoxyHQ ) (Get the news fast)