add readme, gitignore

2024-06-06 10:29:25 -07:00 · 2024-06-06 10:29:25 -07:00 · 50c03b0ab7
commit 50c03b0ab7
parent 7b80847e65
5 changed files with 1374 additions and 2 deletions
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1,2 @@
+target/*
+dist/*
--- a/Cargo.lock
+++ b/Cargo.lock
--- a/Cargo.toml
+++ b/Cargo.toml
@ -1,5 +1,5 @@
 [package]
-name = "knock-knock-yew"
+name = "questions-yew"
 version = "0.1.0"
 edition = "2021"

--- a/README.md
+++ b/README.md
@ -0,0 +1,36 @@
+# Questions - A yew frontend WASM application
+This is a frontend web application intended to provide an interface to the APIs provided by my [questions API rust server](https://gitlab.cecs.pdx.edu/djw2/rust-web). This application is a fork of the course [knock-knock-yew](https://github.com/pdx-cs-rust-web/knock-knock-yew) frontend, primarily authored by Bart Massey
+
+## Contents 
+
+I'll do my best to keep these contents up-to-date as changes are made to the source code
+
+* Setup
+* Dependency overview
+* Source overview
+* Looking ahead
+
+## Setup
+First, the [questions API rust server](https://gitlab.cecs.pdx.edu/djw2/rust-web) should be running on a known address and port
+```
+rustup update
+rustup target add wasm32-unknown-unknown
+cargo install trunk --locked
+cargo build
+```
+
+## Run
+```
+trunk serve
+```
+
+### Dependency overview
+
+#### std
+#### [Yew](https://crates.io/crates/yew)
+
+### Source overview
+
+#### `src/main.rs`
+
+### Looking ahead
--- a/index.html
+++ b/index.html
@ -1,7 +1,7 @@
 <!doctype html>
 <html lang="en">
    <head>
-        <title>Knock Knock!</title>
+        <title>Questions and Answers</title>
        <link data-trunk rel="css" href="index.css" />
    </head>
    <body></body>