database entities

Author: sezanzeb

backend/src/entities/criteria.ts

@@ -0,0 +1,14 @@
+import { Column, Entity, OneToOne, PrimaryGeneratedColumn } from "typeorm";
+import { Longtext } from "./longtext";
+
+@Entity()
+export class Criteria {
+  @PrimaryGeneratedColumn()
+  public readonly id!: number;
+  @Column({ length: 1024 })
+  public title!: string;
+  @Longtext()
+  public description!: string;
+}
+
+// TODO Rating Project and Criteria DTO

backend/src/entities/longtext.ts

@@ -0,0 +1,11 @@
+import { Column } from "typeorm";
+
+export function Longtext() {
+  // Sqlite doesn't support longtext. I hate this, but it is what it is if we want
+  // to keep backend tests and prepare tilt for the upcoming Hackaburg as quickly
+  // as possible.
+  if (process.env.NODE_ENV === "test") {
+    return Column("text");
+  }
+  return Column("longtext");
+}

backend/src/entities/project.ts

@@ -0,0 +1,17 @@
+import { Column, Entity, OneToOne, PrimaryGeneratedColumn } from "typeorm";
+import { Longtext } from "./longtext";
+import { Team } from "./team";
+
+@Entity()
+export class Project {
+  @PrimaryGeneratedColumn()
+  public readonly id!: number;
+  @OneToOne(() => Team, { eager: true })
+  public team!: Team;
+  @Column({ length: 1024 })
+  public title!: string;
+  @Longtext()
+  public description!: string;
+  @Column()
+  public allowRating!: boolean;
+}

backend/src/entities/rating.ts

@@ -0,0 +1,21 @@
+import { Column, Entity, OneToOne, PrimaryGeneratedColumn } from "typeorm";
+import { Criteria } from "./criteria";
+import { Project } from "./project";
+import { User } from "./user";
+
+@Entity()
+export class Rating {
+  @PrimaryGeneratedColumn()
+  public readonly id!: number;
+  @OneToOne(() => User, { eager: true })
+  public user!: User;
+  @OneToOne(() => Project, { eager: true })
+  public project!: Project;
+  @OneToOne(() => Criteria, { eager: true })
+  public critera!: Criteria;
+  @Column()
+  // 1 - 5
+  public rating!: number;
+}
+
+// TODO mvp: only create ratings, no update and delete

backend/src/entities/team.ts

@@ -1,14 +1,5 @@
 import { Column, Entity, PrimaryGeneratedColumn } from "typeorm";
-
-function Longtext() {
-  // Sqlite doesn't support longtext. I hate this, but it is what it is if we want
-  // to keep backend tests and prepare tilt for the upcoming Hackaburg as quickly
-  // as possible.
-  if (process.env.NODE_ENV === "test") {
-    return Column("text");
-  }
-  return Column("longtext");
-}
+import { Longtext } from "./longtext";
 
 @Entity()
 export class Team {

quickstart.md

@@ -3,7 +3,7 @@
 ```sh
 # prep
 cp backend/.env.example backend/.env
-docker run --name backend --network host -v $(pwd):/app -w /app node:alpine yarn
+docker run --name backend --network host -v $(pwd):/app -w /app node:alpine yarn install
 
 # start everything
 docker compose up db phpmyadmin maildev