niko/vi-ilo
1
0
Fork 0
Code Issues 3 Pull requests 1 Projects 1 Releases Packages Wiki Activity Actions
vi-ilo/README.md
Sheldon Cooper da7d75641d feat(ktb): add new-lemma feature, fix some styling.
2026-07-23 01:48:55 -04:00

2 KiB
Raw Blame History

Viossa.net kotoba-tumam

bråtula viossa.net måde! We're here to build an informational website about Viossa.

The Stack

What will we be using to build this site?

Backend

Frontend

  • The ktb frontend is purely coded in HTML, CSS, and browser JS.
  • AlpineJS

Linting

Setup/Installation

How do we install this project?

  1. Download and install Node.js and pnpm
  2. Open your favourite command line terminal
  3. Clone the repository: git clone git@github.com:ViossaDiskordServer/ViossaDotNet.git
  4. Move into the project's root directory: cd ViossaDotNet
  5. Install all project dependencies: pnpm i

Running

How do we run the project?

Turborepo

This project uses Turborepo for task management/caching. Install Turborepo globally on your machine to allow for executing turbo commands more easily: pnpm i -g turbo (this is needed to continue with the instructions below)

Frontend (Viossa.net)

  1. The frontend no longer requires a compilation step. Yippee!

Backend (Viossa DB)

  1. Ensure you're in the root directory of the project (ViossaDotNet)
  2. Move into the app's directory: cd apps/vdb-backend
  3. To run the API, use turbo start. This will build all of the app's dependencies and then start the application.
    1. NOTE: Backend apps are not watched/hot-refreshed like frontend apps! If you make changes, you must kill the app and re-run it to apply changes.
  4. To view a sample response from the backend API, visit http://localhost:1225/sample in your browser!

Visit the GitHub Issues page for this repository.