diff options
author | Yigit Sever | 2021-04-17 20:11:28 +0300 |
---|---|---|
committer | Yigit Sever | 2021-04-17 20:11:28 +0300 |
commit | 94ad41555fd7c6741337ccf2f11e0cdeaf4b74c8 (patch) | |
tree | cae94c3b6fcffb1a964cc192c54439fde1692380 /site/public/index.html | |
parent | d521561b3705bcbb5979a4ed9a768d2c9256df73 (diff) | |
download | gradecoin-94ad41555fd7c6741337ccf2f11e0cdeaf4b74c8.tar.gz gradecoin-94ad41555fd7c6741337ccf2f11e0cdeaf4b74c8.tar.bz2 gradecoin-94ad41555fd7c6741337ccf2f11e0cdeaf4b74c8.zip |
Update docs
Diffstat (limited to 'site/public/index.html')
-rw-r--r-- | site/public/index.html | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/site/public/index.html b/site/public/index.html index ca85dbf..bce3933 100644 --- a/site/public/index.html +++ b/site/public/index.html | |||
@@ -149,6 +149,10 @@ footer { | |||
149 | <a class="subtext" href="https://gradecoin.xyz/#block"><small>- /block</small></a> | 149 | <a class="subtext" href="https://gradecoin.xyz/#block"><small>- /block</small></a> |
150 | </div> | 150 | </div> |
151 | 151 | ||
152 | <div class="toc-item-child"> | ||
153 | <a class="subtext" href="https://gradecoin.xyz/#user"><small>- /user</small></a> | ||
154 | </div> | ||
155 | |||
152 | 156 | ||
153 | 157 | ||
154 | <div class="toc-item"> | 158 | <div class="toc-item"> |
@@ -161,6 +165,10 @@ footer { | |||
161 | </div> | 165 | </div> |
162 | 166 | ||
163 | <div class="toc-item-child"> | 167 | <div class="toc-item-child"> |
168 | <a class="subtext" href="https://gradecoin.xyz/#how-do-you-actually-earn-gradecoin"><small>- How do you actually earn Gradecoin?</small></a> | ||
169 | </div> | ||
170 | |||
171 | <div class="toc-item-child"> | ||
164 | <a class="subtext" href="https://gradecoin.xyz/#i-found-a-bug"><small>- I found a bug!</small></a> | 172 | <a class="subtext" href="https://gradecoin.xyz/#i-found-a-bug"><small>- I found a bug!</small></a> |
165 | </div> | 173 | </div> |
166 | 174 | ||
@@ -249,15 +257,26 @@ The server is programmed in <a href="https://www.service-architecture.com/articl | |||
249 | <p><code>Authorization</code>: The request header should have Bearer JWT.Token signed with Student Public Key</p> | 257 | <p><code>Authorization</code>: The request header should have Bearer JWT.Token signed with Student Public Key</p> |
250 | </li> | 258 | </li> |
251 | </ul> | 259 | </ul> |
260 | <h2 id="user">/user</h2> | ||
261 | <ul> | ||
262 | <li>Meant to be used in the browser, you can see the current list of users and their balance here</li> | ||
263 | </ul> | ||
252 | <h1 id="questions">Questions</h1> | 264 | <h1 id="questions">Questions</h1> |
253 | <h2 id="this-all-sound-complicated">This all sound complicated!</h2> | 265 | <h2 id="this-all-sound-complicated">This all sound complicated!</h2> |
254 | <ul> | 266 | <ul> |
255 | <li>I've drawn inspiration from <a href="https://explorer.bitcoin.com/btc">actual Bitcoin transactions</a> and <a href="https://github.com/seanmonstar/warp/blob/master/examples/todos.rs">warp</a>. The simplicity of the system is how little interfaces it has.</li> | 267 | <li>I've drawn inspiration from <a href="https://explorer.bitcoin.com/btc">actual Bitcoin transactions</a> and <a href="https://github.com/seanmonstar/warp/blob/master/examples/todos.rs">warp</a>. The simplicity of the system is how little interfaces it has.</li> |
256 | <li>Don't know where to start? Gradecoin uses RESTful API; simple <code>curl</code> commands or even your browser will work! <a href="https://curl.trillworks.com/">This website can help as well</a>.</li> | 268 | <li>Don't know where to start? Gradecoin uses RESTful API; simple <code>curl</code> commands or even your browser will work! <a href="https://curl.trillworks.com/">This website can help as well</a>.</li> |
257 | <li><a href="https://jwt.io">JWT Debugger</a> and the corresponding <a href="https://tools.ietf.org/html/rfc7519">RFC</a></li> | 269 | <li><a href="https://jwt.io">JWT Debugger</a> and the corresponding <a href="https://tools.ietf.org/html/rfc7519">RFC</a>.</li> |
258 | <li>Remember that you are absolutely encouraged to grab off-the-shelf implementations for every cryptography primitive you will use. You can start by finding a code snippet to generate a RSA keypair?</li> | 270 | <li>Remember that you are absolutely encouraged to grab off-the-shelf implementations for every cryptography primitive you will use. You can start by finding a code snippet to generate a RSA keypair?</li> |
259 | <li>Check out <a href="https://gradecoin.xyz/misc-docs/">misc</a> for everything else you might be curious about.</li> | 271 | <li>Check out <a href="https://gradecoin.xyz/misc-docs/">misc</a> for everything else you might be curious about.</li> |
260 | </ul> | 272 | </ul> |
273 | <h2 id="how-do-you-actually-earn-gradecoin">How do you actually earn Gradecoin?</h2> | ||
274 | <ul> | ||
275 | <li>Register yourself to at <a href="https://gradecoin.xyz/register-docs/">/register</a></li> | ||
276 | <li>Create transactions at <a href="https://gradecoin.xyz/transaction-docs/">/transaction</a></li> | ||
277 | <li>Create blocks to commit transactions at <a href="https://gradecoin.xyz/block-docs/">/block</a></li> | ||
278 | <li>See how everyone is doing and find people to trade with at <a href="/user">/user</a></li> | ||
279 | </ul> | ||
261 | <h2 id="i-found-a-bug">I found a bug!</h2> | 280 | <h2 id="i-found-a-bug">I found a bug!</h2> |
262 | <p>Thank you! Please <a href="mailto:yigit@ceng.metu.edu.tr">let me know</a> so we can solve it.</p> | 281 | <p>Thank you! Please <a href="mailto:yigit@ceng.metu.edu.tr">let me know</a> so we can solve it.</p> |
263 | <h2 id="i-hacked-the-server">I hacked the server!</h2> | 282 | <h2 id="i-hacked-the-server">I hacked the server!</h2> |