Skip to content

Latest commit

 

History

History
50 lines (28 loc) · 1.64 KB

README.md

File metadata and controls

50 lines (28 loc) · 1.64 KB
Raw

Rust Web Example: PostgreSQL via Docker

Cole Nemec 2024.

This is repository for my work in Bart Massey's CS410P taught in Spring '24 at PSU.

Run the Code

Servers:

Required: Ensure a file located at db/password.txt exists from the root directory. Write your choice of a database password in this file. In addition, ensure a .env file exists to define the variables BAD_WORDS_API_KEY, PASETO_KEY, and PORT.

Call docker-compose up --build on a freshly-installed pull of this repo to start 2 Docker containers running the database and Rust web app.

There may be issues with volumes or something... use the following command to fix it:

$ docker-compose down --volumes

This allowed me to run docker-compose up --build successfully again.

Front end:

After this repository is cloned, navigate to the base of the repo directory and run the following commands to pull the front end submodule code into questionbase-yew:

git submodule init
git submodule update

Then, navigate to questionbase-yew and run trunk serve --open to start the front end and open it in your browser.

Usage:

After Docker is running the servers...

A templated webpage containing a random question can be visited by accessing the <url>/ endpoint.

A question (in formatted JSON) can be added to the database by POSTing to the <url>/api/question/add/ endpoint.

See files in questions/ for examples of the JSON format of a question.

add_questions.sh is a script to add any .json file in questions/ to the database via this endpoint.

View the DB's contents by accessing the <url>/api/questions endpoint.