https://github.com/flashbots/flashbots-docs
https://github.com/flashbots/flashbots-docs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/flashbots/flashbots-docs
- Owner: flashbots
- License: mit
- Created: 2021-04-06T15:43:43.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T23:50:10.000Z (over 1 year ago)
- Last Synced: 2024-09-18T18:35:51.822Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://docs.flashbots.net
- Size: 12.2 MB
- Stars: 188
- Watchers: 26
- Forks: 145
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: docs/code-of-conduct.mdx
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Installation
Use Node.js v18+
Note: if you want to install the node packages from within a Docker container (recommended for security), then you can start it like this:
```bash
docker run -p 3000:3000 --rm -it -w /mnt -v $(pwd):/mnt node:18 /bin/bash
```
First create a copy of the environment file `.env.template` in the root of the codebase and rename it to `.env`
Then run the following:
```console
yarn install
```
## Local Development
First create a local `.env` file to fill in env variable placeholders necessary for setting up the development. Note that these are merely placeholders.
```sh
cp .env.template .env
```
Then run the below command to start a local development server (and may open up a browser window). Some changes are reflected live without having to restart the server.
```console
yarn start
```
You can open the local docs at [http://localhost:3000/](http://localhost:3000/)
## Build
```console
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Create a PR and once merged, Github actions automatically deploy it.
The docs use Vercel for hosting, and deployment is done by Vercel on any merge into the master branch.