docs: vuepress setup and section titles (#311)

* vuepress * docs: vuepress setup and TODOs * doc scripts * update Makefile and gitignore * more docs updates * gitignore * metamask instructions * update image * updates * updates from call * docs: vuepress config and home.vue (#350) * update uncles return (#337) * x/evm: fix EndBlock consensus failure (#334) * add test for sending tx w/ 21000 gas * improve rpc transfer test * use ctx in EndBlock * UpdateAccounts and ClearStateObjects with passed in context * log ethereum address on error Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Federico Kunze <federico.kunze94@gmail.com> * update Ethermint color variables * add header and footer logo * tweak config.js * WIP custom homepage.vue * add layout to docs/README * update color variables * add eth logo black and white * tweak docs/README * update logo and logo-bw svg * bump 1.0.167 * homepage → home * add icon-code, icon-rocket * layout: home, remove configurable frontmatter: label, read, use * clean up config.js * bump 1.0.168 * fix missing comma from resolving conflicts * update sidebar, config nav, path * remove left whitespace on the header and footer logos * clean up home.vue, docs/README * update ethermint forum url in footer.links * comment out custom true to enable searchbar in subpages * remove external link icon for Guides * comments, revert custom true * clean up config.js, add specifications icon Co-authored-by: noot <36753753+noot@users.noreply.github.com> Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Federico Kunze <federico.kunze94@gmail.com> * final touches Co-authored-by: Cyrus Goh <hello@lovincyrus.com> Co-authored-by: noot <36753753+noot@users.noreply.github.com>
2020-07-02 04:22:45 -04:00
parent edf4357176
commit d4fe9b234c
36 changed files with 12230 additions and 105 deletions
@@ -0,0 +1,17 @@
+<!--
+order: false
+parent:
+  order: 2
+-->
+
+# Quick Start
+
+This repository contains reference documentation on the basic concepts of Ethermint.
+
+1. [Run a Node](./run_node.md)
+
+After going throught the Quick Start contents, head over to the [basics](./../basics/README.md) to learn more.
+
+## Next {hide}
+
+Learn how to run an Ethermint [node](./../quickstart/run_node.md) {hide}
@@ -0,0 +1,85 @@
+<!--
+order: 1
+-->
+
+# Run a Node
+
+Run a local node and start the REST and JSON-RPC clients {synopsis}
+
+Clone and build Ethermint:
+
+```bash
+git clone <https://github.com/ChainSafe/ethermint>
+cd ethermint
+make install
+```
+
+Run the local testnet node with faucet enabled:
+
+::: warning
+The script below will remove any pre-existing binaries installed
+:::
+
+```bash
+./init.sh
+```
+
+In another terminal window or tab, run the Ethereum JSON-RPC server as well as the SDK REST server:
+
+```bash
+emintcli rest-server --laddr "tcp://localhost:8545" --unlock-key mykey --chain-id 8
+```
+
+## Key Management
+
+To run a node with the same key every time:
+replace `emintcli keys add $KEY` in `./init.sh` with:
+
+```bash
+echo "your mnemonic here" | emintcli keys add ethermintkey --recover
+```
+
+::: tip
+Ethermint currently only supports 24 word mnemonics.
+:::
+
+You can generate a new key/mnemonic with
+
+```bash
+emintcli keys add <mykey>
+```
+
+To export your ethermint key as an ethereum private key (for use with Metamask for example):
+
+```bash
+emintcli keys unsafe-export-eth-key <mykey>
+```
+
+## Requesting tokens though the testnet faucet
+
+Once the ethermint daemon is up and running, you can request tokens to your address using the `faucet` module:
+
+```bash
+# query your initial balance
+emintcli q bank balances $(emintcli keys show <mykey> -a)  
+
+# send a tx to request tokens to your account address
+emintcli tx faucet request 100photon --from <mykey>
+
+# query your balance after the request
+emintcli q bank balances $(emintcli keys show <mykey> -a)
+```
+
+You can also check to total amount funded by the faucet and the total supply of the chain via:
+
+```bash
+# total amount funded by the faucet
+emintcli q faucet funded
+
+# total supply
+emintcli q supply total
+```
+
+## Next {hide}
+
+Learn about Ethermint [accounts](./../basic/accounts.md) {hide}