diff options
| author | Yigit Sever | 2022-04-23 18:16:35 +0300 |
|---|---|---|
| committer | Yigit Sever | 2022-04-23 18:16:35 +0300 |
| commit | d76de7951d995026feaeb92c278f45e810acd3de (patch) | |
| tree | 8e735ef1f04f9b94aae862abab85872647742d9b | |
| parent | b4b4c3588c1fe9f6cdc9a1bc741d537b5160b9f9 (diff) | |
| download | gradecoin-d76de7951d995026feaeb92c278f45e810acd3de.tar.gz gradecoin-d76de7951d995026feaeb92c278f45e810acd3de.tar.bz2 gradecoin-d76de7951d995026feaeb92c278f45e810acd3de.zip | |
Make README more professional
| -rw-r--r-- | README.md | 14 |
1 files changed, 3 insertions, 11 deletions
| @@ -1,8 +1,8 @@ | |||
| 1 | # Gradecoin | 1 | # Gradecoin |
| 2 | 2 | ||
| 3 | This is designed to sit behind nginx reverse proxy so running at 127.0.0.1:8080 or not using https is not a problem. | 3 | Gradecoin is a undergraduate level cryptography simulation/game that masquerades as a cryptocurrency. |
| 4 | 4 | ||
| 5 | It's currently live over at https://gradecoin.xyz. | 5 | The project is live at https://gradecoin.xyz. |
| 6 | 6 | ||
| 7 | ```sh | 7 | ```sh |
| 8 | # Test the project | 8 | # Test the project |
| @@ -40,6 +40,7 @@ $ cargo run | |||
| 40 | ``` | 40 | ``` |
| 41 | 41 | ||
| 42 | The server should be up on `localhost:8080`. | 42 | The server should be up on `localhost:8080`. |
| 43 | We recommend using Nginx to reverse proxy Gradecoin so it can be served as HTTPS. | ||
| 43 | 44 | ||
| 44 | The default config file is `config.yaml`. | 45 | The default config file is `config.yaml`. |
| 45 | You can specify another config file with: | 46 | You can specify another config file with: |
| @@ -61,12 +62,3 @@ You can clear the database for all networks by running: | |||
| 61 | $ rm -rf blocks users | 62 | $ rm -rf blocks users |
| 62 | ``` | 63 | ``` |
| 63 | Or you can delete the database for a particular network by removing `blocks/network_name` and `users/network_name`. | 64 | Or you can delete the database for a particular network by removing `blocks/network_name` and `users/network_name`. |
| 64 | |||
| 65 | # References | ||
| 66 | - https://github.com/blurbyte/restful-rust | ||
| 67 | - https://github.com/zupzup/warp-postgres-example | ||
| 68 | - https://blog.logrocket.com/create-an-async-crud-web-service-in-rust-with-warp/ | ||
| 69 | |||
| 70 | # How to be a good server | ||
| 71 | - https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | ||
| 72 | - https://tools.ietf.org/html/rfc7231 | ||