tornadocash/ docs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Official protocol documentation.
184 Commits 3 Branches 0 Tags 108 MiB
JavaScript 100%
Go to file
ButterflyEffect 1ee069e1c2 update ui version 2024-01-19 05:07:53 +00:00
book update ui version 2024-01-19 05:07:53 +00:00
scripts Change repo structure & add script to for IPFS deployment and build commands 2023-07-26 07:36:06 -07:00
.env.example Change repo structure & add script to for IPFS deployment and build commands 2023-07-26 07:36:06 -07:00
.gitignore Change repo structure & add script to for IPFS deployment and build commands 2023-07-26 07:36:06 -07:00
.nvmrc Change repo structure & add script to for IPFS deployment and build commands 2023-07-26 07:36:06 -07:00
README.md Change repo structure & add script to for IPFS deployment and build commands 2023-07-26 07:36:06 -07:00
package-lock.json Change repo structure & add script to for IPFS deployment and build commands 2023-07-26 07:36:06 -07:00
package.json Improve commands, clean and rebuild before deploy on IPFS 2023-07-28 04:38:39 -07:00

README.md

Tornado Cash Documentation

UI for non-custodial Ethereum Privacy solution

Read static content

Entrypoint here: docs

Building locally

  • Install Node.js version 10.24
    • If you are using 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

Deploy on IPFS

  • Copy .env.example file to .env
  • 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