konsol-2024

KONSol is an information screen in Konsulatet. The project contains the page that is shown on the screen, an admin page to upload slides, and a backend written in Actix.

Features:

• Ability to upload slides (images, title, text, date) that will be shown on the screen.
• SL departure data.
• Fysiksektionen calendar integration.

Backend config

• Environment Variables: (Defined in backend/.env)
  • DATABASE_URL: Path to the SQLite database file.
  • IMAGE_PATH: Directory where slide images are stored. Defaults to /tmp/konsol_slides. Warning: Currently all files in this directory are served under /api/screen/slides/images.

Endpoints

See endpoints.

Development setup

Backend

1. Make sure Rust is installed and cargo works. Otherwise, install Rust.
2. Install Diesel CLI, for example by running cargo install diesel_cli or cargo-binstall diesel_cli.
3. Navigate to backend/ and run diesel migration run.
4. To fill the database with 4 mock slides, navigate to backend/scripts and (while in that directory) run python3 mock_data.py.
5. Run the backend with cargo run or cargo r from the backend/ directory. (The port will be displayed in the terminal)

Frontends

1. Make sure node and npm are both installed.
2. Navigate to either screen-frontend/ or admin-frontend and run npm install.
3. Run the frontend with npm run dev. (The port will be displayed in the terminal)