Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 2.45 KB

README.md

File metadata and controls

57 lines (35 loc) · 2.45 KB
Raw

pacta-dashboard-svelte

ci docker build version license

This Svelte project builds a static site that contains the PACTA dashboard front-end. The project utilizes Svelte, SvelteKit, Vite, TypeScript, Tailwind, and Skeleton UI to deliver a modern and responsive dashboard for the PACTA project.

Developing

You will need to have Node.js installed on your machine. You can download it from nodejs.org.

First, install the dependencies:

npm install # or pnpm install or yarn

Then start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

This project uses Vite, which is a build tool that aims to provide a faster and leaner development experience for modern web projects. It's configured in vite.config.js.

Building

Development

To create a local development version of the dashboard:

npm run build

You can preview the production build with npm run preview.

Production

Production builds of the dashboard are built using a docker container (defined with Dockerfile). This container executes a script to run npm run build, and then copy the rendered files from the default build directory to /mnt/build_artifacts/ in the container.

The simplest way to use this is with docker-compose up --build, which will run the build container as an init container. Once that has completed sucessfully, a nginx container (with the rendered files bind-mounted to the correct location) will start, and the prepared dashboard will be visible at localhost:3000.

Backend

The dashboard is designed to be used with the PACTA backend, which can be found here

License

This project is licensed under the MIT License - see the LICENSE file for details.