Vaaliplatta

Docs

Setting up:

docker compose up -d

nvm use .nvmrc

# /vaaliplatta/backend
npm install
cp .env.template .env # Remember to check all values
npm run create-test-data
npm run dev

# /vaaliplatta/frontend
npm install
npm run dev

Creating migrations:

1. Write a migration file with name "m[timestamp].ts" into backend/src/migrations. The migrations are applied by kysely-migrate in alphabetical order so naming convention has to be followed.
2. Add up and down methods according to examples.

export async function up(db: Kysely<any>): Promise<void> {}
export async function down(db: Kysely<any>): Promise<void> {}

3. The backend runs up migrations by default in backend/src/index.ts

After running the migration up, you need to run npm run kysely-codegen to create types for the new db schema. This creates the file db.d.ts, which is tracked in git. Therefore, you only need to run kysely-codegen when creating new migrations.

If the migration fails in dev environment, just run docker compose down and docker compose up.

DB schema

Generated with dbmate dump (has to be installed separately) and chatgpt. May not be entirely accurate.

erDiagram
    ELECTION {
        integer id PK
        text name
        text description
        state state
    }
    POSITION {
        integer id PK
        text name
        text description
        text seats
        integer election_id FK
        text category
        state state
    }
    APPLICATION {
        integer id PK
        text content
        text profile_picture
        text applicant_name
        text applicant_id
        integer position_id FK
    }
    QUESTION {
        integer id PK
        text content
        text nickname
        text asker_id
        integer position_id FK
    }
    ANSWER {
        integer id PK
        text content
        integer question_id FK
        text answerer_id
    }
    READ_RECEIPTS {
        integer application_id FK
        text user_id
        timestamp time
    }

    ELECTION ||--o{ POSITION : "has"
    POSITION ||--o{ APPLICATION : "has"
    POSITION ||--o{ QUESTION : "has"
    APPLICATION ||--o{ READ_RECEIPTS : "tracks"
    QUESTION ||--o{ ANSWER : "answers"

Loading