fbla26/README.md
DragonDuck24 2a1436515b
All checks were successful
ci / docker_image (push) Successful in 3m14s
ci / deploy (push) Successful in 30s
Readme fix
2026-02-07 01:03:54 -06:00

2.2 KiB

Westuffind - FBLA 2026

Overview

This is a lost and found application built using SvelteKit for the 2026 FBLA Website Coding & Development event. It allows users to browse items, post found items, and manage them. The application is designed for fast performance and a seamless user experience.

Features

  • User authentication (login/signup/logout)
    • Email-only token-based methods for non-admins
  • Browse/search items
  • Post found items
  • Inquire about items
  • Claim items
  • Email notifications
  • Themes

Installation

To set up the project locally, follow these steps:

Prerequisites

Clone the repository

git clone https://git.marinodev.com/MarinoDev/FBLA25
cd FBLA25

Create a .env file in the root directory and configure environment variables. .env.example is provided as a template. Download a LLaMA compatible LLM (and mmproj) to llm-models. I recommend Qwen3-VL-2B-Instruct.

Docker

A Dockerfile and docker-compose.yml file are provided for running the application in a Docker container.

Manual

Using Docker is strongly recommended, as it bundles the database and the AI.

Install dependencies

npm install

Start the development server

npm run dev

Go to http://localhost:5173/ (or the port shown in the terminal).

Deployment

To deploy the application, build it using:

npm run build
node build

Resources Used

Technologies

Libraries