Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 1.82 KB

README.md

File metadata and controls

56 lines (32 loc) · 1.82 KB
Raw

Final Year Project

Overview

✨ This workspace has been generated by Nx, Smart Monorepos · Fast CI. ✨, it contains the following packages:

  1. webapp Including the source code for the Frontend web application, and Backend migrations/hooks
  2. design-system PandaCSS Configuration for design tokens used by the Frontend
  3. webapp-e2e E2E tests for the web application, currently missing the manual tests specified in the main document.

Pre-requisites

  1. Install pnpm
  2. Install packages using pnpm install at the root of the workspace.
  3. Download and extract the pocketbase executable v0.22.5 from the assets section, and place it at packages/webapp
  4. Run the Backend
  5. Run the Frontend

Running the Backend

The Backend is written using pocketbase, and can be run as follows:

# Assuming the binary is extracted and named pocketbase_bin
cd packages/webapp
./pocketbase_bin serve

Running the Frontend

The frontend is written in vite, and can be started from the workspace as follows

pnpm nx run webapp:dev

Explore the project graph

A preview of the Project Graph:

Project Graph

You can also run pnpm nx graph to show the graph of the workspace. It will show tasks that you can run with Nx.

Nx Console

Enhance your Nx experience by installing Nx Console for your favorite editor. It makes it easier to view the project structure and available commands