david/rust-web
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
David Westgate 2024-05-29 12:34:59 -07:00
parent 8678106283
commit b34ffe8029
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -21,6 +21,8 @@ First install Rust. I suggest using the [rustup toolchain](https://rustup.rs/)
#### Database #### Database
A postgres database is required. At this time, the database must be setup and run manually (using docker is recommended). Create a database within postgres called `questionanswer` and choose a password. Set this password in `.cargo/config.toml` A postgres database is required. At this time, the database must be setup and run manually (using docker is recommended). Create a database within postgres called `questionanswer` and choose a password. Set this password in `.cargo/config.toml`
It is convient to run postgres in docker with the postgres:latest docker image
#### Build and Run #### Build and Run
``` ```
cargo run cargo run
@ -64,6 +66,11 @@ The store is responsible for the management of the questions. It does this by
* Handling possible file or I/O errors with some sense of grace before panicing * Handling possible file or I/O errors with some sense of grace before panicing
### `questions.json` ### `questions.json`
A test dataset of questions. Generated by [ChatGPT](https://chat.openai.com/) A test dataset of questions. Generated by [ChatGPT](https://chat.openai.com/)
### `question_tag.rs`
### `tag.rs`
### `answer.rs`
### Looking ahead ### Looking ahead
These are a few things still to be added These are a few things still to be added
#### Higher priority #### Higher priority