Hints (#8)

* refactor 1

* refactor 2

* refactor

* logging

* add identifieres from rules

* bug fix

* api update

* checking for correct trees

* sea-orm-generation

* add missing rules

* tipps

* hints done

* format & prints

* changed to drawer

* no static frontend anymore

Author: The-Ray-Man

.github/workflows/publish.yaml

@@ -26,16 +26,34 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata from event
+      - name: Extract metadata for frontend
+        id: meta-frontend
         uses: docker/metadata-action@v5
-        id: meta
         with:
-          images: ghcr.io/${{ github.repository }}
+          images: ghcr.io/${{ github.repository }}/frontend
 
-      - name: Build and push
+      - name: Extract metadata for backend
+        id: meta-backend
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}/backend
+
+      - name: Build and push frontend image
+        uses: docker/build-push-action@v6
+        with:
+          context: frontend
+          file: frontend/Dockerfile
+          push: true
+          tags: ${{ steps.meta-frontend.outputs.tags }}
+          labels: ${{ steps.meta-frontend.outputs.labels }}
+          secrets: |
+            API_URL=${{secrets.NEXT_PUBLIC_API_URL}}
+
+      - name: Build and push backend image
         uses: docker/build-push-action@v6
         with:
-          context: .
+          context: backend
+          file: backend/Dockerfile
           push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          tags: ${{ steps.meta-backend.outputs.tags }}
+          labels: ${{ steps.meta-backend.outputs.labels }}

Dockerfile

@@ -22,12 +22,15 @@ This project consists of three parts: Frontend, Backend and Database.
     - Run ```npm run dev```
 
 ### Database Migration
-If you change the database schema you need to manually push the file again to the database. Additionally, in the backend run 
-
+If you change the database schema you need to manually push the file again to the database. 
 ```shell
 npx prisma db push --schema ../db/schema.prisma --database-url ...
 ```
-to update the rust crate with the new database structure.
+Additionally, in the backend run to update the rust crate with the new database structure.
+```shell
+sea-orm-cli generate entity -o ./src/db/ --database-url ...
+```
+You may need to install ```sea-orm-cli```.
 
 ### API changes
 To be able to use new or changed endpoints in the frontend the following steps must be done:

README.md

@@ -27,6 +27,7 @@ utoipauto = "=0.3.0-alpha.1"
 tower = { version = "0.5.2", optional = true }
 log = "0.4.26"
 env_logger = "0.11.6"
+tracing = "0.1.41"
 
 [features]
 static = ["tower-http/fs", "tower"]

backend/Cargo.lock

@@ -0,0 +1,20 @@
+FROM rust:alpine3.19 AS api-builder
+
+WORKDIR /app
+RUN apk add --no-cache musl-dev z3 cmake g++ make python3 curl clang16-libclang z3-dev
+
+COPY backend .
+ENV RUSTFLAGS='-C target-feature=-crt-static'
+# RUN cargo build --release --features static
+RUN cargo build --release
+
+
+FROM alpine:3.19 AS backend
+
+WORKDIR /app
+COPY --from=api-builder /app/target/release/naturalDeduction ./server
+RUN apk add --no-cache z3 z3-dev
+
+EXPOSE 8000
+
+CMD [ "./server" ]

backend/Cargo.toml

@@ -1,10 +1,5 @@
-pub mod exercise_models;
-pub mod formula_models;
 pub mod models;
-pub mod normalize;
 pub mod routes;
-pub mod rule_models;
-pub mod utils;
 
 use axum::routing::{get, post};
 use axum::Router;
@@ -20,6 +15,8 @@ pub fn get_router(state: &AppState) -> Router {
         .route("/parse", post(routes::parse))
         .route("/rules", get(routes::all_rules))
         .route("/check", post(routes::check))
+        .route("/statement/hint", post(routes::get_tipp))
+        .route("/add_tree", post(routes::add_tree))
         .route("/exercise/{id}/feedback", post(routes::post_feedback))
         // .route("/tree", post(routes::add_tree))
         .with_state(state.clone())

backend/Dockerfile

@@ -1,10 +1,40 @@
 use serde::{Deserialize, Serialize};
-use utoipa::{IntoParams, ToSchema};
+use utoipa::ToSchema;
+use uuid::Uuid;
 
-use super::{
-    formula_models::{Formula, Statement},
-    rule_models::Rules,
-};
+use utoipa::IntoParams;
+
+use crate::lib::derivation::{formula::Formula, statement::Statement};
+use crate::lib::rule::Rules;
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema, PartialEq, Eq, PartialOrd, Ord)]
+pub struct CreateExerciseRequest {
+    pub lhs: Vec<Formula>,
+    pub rhs: Formula,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+pub struct Exercise {
+    pub id: Uuid,
+    pub exercise: Statement,
+    pub likes: i32,
+    pub dislikes: i32,
+    pub difficulty: f64,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+pub struct Node {
+    pub name: Uuid,
+    pub statement: Statement,
+    pub rule: Rules,
+    pub premisses: Vec<Uuid>,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+pub struct CreateTreeRequest {
+    pub nodes: Vec<Node>,
+    pub root_id: Uuid,
+}
 
 #[derive(Serialize, Deserialize, Debug, Clone, ToSchema, IntoParams)]
 pub struct FormulaMapping {
@@ -31,3 +61,14 @@ pub struct Feedback {
     pub like: bool,
     pub difficulty: Option<u32>,
 }
+
+#[derive(Serialize, Deserialize, Debug, Clone, ToSchema, IntoParams)]
+pub struct ParseParams {
+    pub formula: String,
+}
+
+#[derive(Serialize, Deserialize, Debug, Clone, ToSchema, IntoParams)]
+pub struct Tipp {
+    pub rule: Rules,
+    pub premisses: Vec<Statement>,
+}