🗺️ pathfinding

A CRUD application made with SvelteKit for visualizing the *A** algorithm on customizable mazes. Originally made for my MMSU CS116 & CS131 Project.

Setup

Installation

Install the latest NodeJS LTS version from the official website or through Node Version Manager: nvm for Linux, and nvm-win for Windows.

Afterwards, install dependencies (preferably pnpm) with the following commands:

npm install -g pnpm
pnpm install

Docker (for development)

Docker Compose is used to run necessary third-party services such as PostgreSQL for development. Install Docker Desktop from the offical website to start.

# start containers
docker-compose up -d

# stop containers
docker-compose stop

# delete containers (--volumes is optional if you also want to remove data volumes)
docker-compose down --volumes

Development

Database Migration

The project lacks a Database Migration Framework for automatically syncing schemas. In order to setup the database schema for this project, a simple script can be used instead whicn can be executed with the following command.

pnpm vite-node "./src/lib/server/migrations/migrate"

Development Server

Start the development server with the following command.

pnpm run dev