vinet/viossa.net
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
This is the core repo for the informational website "viossa.net" (base domain) about the Viossa artificial pidgin language
54 commits 1 branch 0 tags 567 KiB
Find a file
Benjamin Singleton d35ca7f3ba fix: cleanup temp code
2025-06-14 12:46:37 -05:00
.vscode First commit 2025-05-08 02:47:09 +00:00
apps fix: cleanup temp code 2025-06-14 12:46:37 -05:00
libs/common fix: updated README instructions + fixed app running issues/cross-compatibility over operating systems 2025-06-12 18:13:50 -04:00
.gitattributes feat: unplugin-vue-router, prettier, eslint, .gitattributes 2025-05-13 15:24:17 -05:00
.gitignore feat: sample lib & turborepo setup 2025-06-12 18:13:50 -04:00
.prettierrc fix: updated README instructions + fixed app running issues/cross-compatibility over operating systems 2025-06-12 18:13:50 -04:00
package.json feat: sample lib & turborepo setup 2025-06-12 18:13:50 -04:00
pnpm-lock.yaml feat: added vueuse for onClickOutside, upgraded functionality for hamburger menu and locale picker 2025-06-14 12:38:57 -05:00
pnpm-workspace.yaml feat: setup monorepo for static frontend app (vdn-static) 2025-06-12 18:13:50 -04:00
README.md fix: Update instructions for backend running 2025-06-12 18:13:50 -04:00
turbo.json fix: updated README instructions + fixed app running issues/cross-compatibility over operating systems 2025-06-12 18:13:50 -04:00
vite.config.ts chore: Refactored home page content out of App.vue and into separate index.vue file created for the vue-router 2025-05-20 18:21:58 -04:00

README.md

Viossa.net

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?

Core

Frontend

Additionally, we will be following atomic design principles to organize the components of the project.

Styling

Backend

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. Ensure you're in the root directory of the project (ViossaDotNet)
  2. Move into the app's directory: cd apps/vdn-static
  3. Now, to run the site, use turbo dev. This will set up watchers to build all libraries used by the frontend, as well as hot-refreshing the site as changes are made to it.
  4. To view the website running locally, visit http://localhost:1224/ in your browser!

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. Now, to run the site, 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 by spamming Ctrl+C in the terminal it is running in, before rerunning it with the changes applied.
  4. To view a sample response from the backend API, visit http://localhost:1225/sample in your browser!

The Content

What will be in the site?

Visit the GitHub Issues page for this repository.