2023-07-26 17:36:06 +03:00
|
|
|
# Tornado Cash Documentation
|
2021-04-07 13:02:32 +03:00
|
|
|
|
2023-07-26 17:36:06 +03:00
|
|
|
> UI for non-custodial Ethereum Privacy solution
|
2021-08-25 17:32:23 +03:00
|
|
|
|
2023-01-28 19:55:19 +03:00
|
|
|
|
2021-08-25 17:32:23 +03:00
|
|
|
|
2023-07-26 17:36:06 +03:00
|
|
|
### Read static content
|
2021-08-25 17:32:23 +03:00
|
|
|
|
2023-07-26 17:36:06 +03:00
|
|
|
Entrypoint here: [docs](book/README.md)
|
2021-08-25 17:32:23 +03:00
|
|
|
|
2023-07-26 17:36:06 +03:00
|
|
|
### Building locally
|
2021-08-25 17:32:23 +03:00
|
|
|
|
2023-07-26 17:36:06 +03:00
|
|
|
* Install [Node.js](https://nodejs.org) version 10.24
|
|
|
|
|
* If you are using [nvm](https://github.com/nvm-sh/nvm) (recommended) running `nvm use` will automatically choose the right node version for you.
|
|
|
|
|
* Install dependencies: `npm i`
|
|
|
|
|
* Install gitbook dependencies: `npm run prepare`
|
|
|
|
|
* Build gitbook to static content: `npm run build`
|
2021-08-25 17:32:23 +03:00
|
|
|
|
2023-07-26 17:36:06 +03:00
|
|
|
## Deploy on IPFS
|
2021-08-25 17:32:23 +03:00
|
|
|
|
2023-07-26 17:36:06 +03:00
|
|
|
* Copy `.env.example` file to `.env`
|
2021-08-25 17:32:23 +03:00
|
|
|
|
2023-07-26 17:36:06 +03:00
|
|
|
- Make sure you set `PINATA_API_KEY` and `PINATA_SECRET_API_KEY` environment variables in `.env`
|
|
|
|
|
- To deploy a production build run `npm run deploy:ipfs`
|
