waku.guide/README.md

30 lines
1.2 KiB
Markdown
Raw Normal View History

2022-08-04 11:42:53 +00:00
# Website
2022-07-29 05:46:00 +00:00
2022-08-04 11:42:53 +00:00
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
2022-07-29 05:46:00 +00:00
2022-08-04 11:42:53 +00:00
### Installation
2022-07-29 06:12:02 +00:00
2022-08-04 11:42:53 +00:00
```
$ yarn
```
2022-07-29 06:12:02 +00:00
2022-08-04 11:42:53 +00:00
### Local Development
2022-07-29 06:12:02 +00:00
2022-08-04 11:42:53 +00:00
```
$ yarn start
```
2022-07-29 06:12:02 +00:00
2022-08-04 11:42:53 +00: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.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
2022-08-16 12:34:45 +00:00
For our current stage, we use Vercel for Deployment and hosting. [Vercel](https://vercel.com/about) provides us with various benefits in the areas of performance and ease of use that is great for our initial stage.
Each project first needs to be defined & imported to Vercel (for this you can always contact Comms people).
After your project has been imported, all subsequent pushes to branches will generate [Preview Deployments](https://vercel.com/docs/concepts/deployments/environments#preview), and all changes made to the [Production Branch](https://vercel.com/docs/concepts/git#production-branch) (usually "main" or "master") will result in a [Production Deployment](https://vercel.com/docs/concepts/deployments/environments#production).