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
98 commits 1 branch 0 tags 567 KiB
Find a file
TheEnamur adccf7f979
Update es_LA.ftl 
Historia del Viossa -> Historia de Viossa
2026-04-17 16:03:31 -04:00
.github/workflows fix: scripts 2026-02-08 08:34:21 -05:00
.vscode First commit 2025-05-08 02:47:09 +00:00
apps Update es_LA.ftl 2026-04-17 16:03:31 -04:00
libs/common fix: page styling, search page 2026-01-17 16:19:08 -05:00
.gitattributes feat: unplugin-vue-router, prettier, eslint, .gitattributes 2025-05-13 15:24:17 -05:00
.gitignore feat: degoogle (#37) 2026-01-29 22:45:33 -05:00
.prettierrc fix: updated README instructions + fixed app running issues/cross-compatibility over operating systems 2025-06-10 21:10:55 -05:00
deploy.sh tweak: scripts 2026-02-09 20:30:40 -05:00
package-lock.json wip: add db classes; can't load SQLite driver. 2025-09-10 17:55:28 -04:00
package.json feat: add API 2025-09-11 23:15:08 -04:00
pnpm-lock.yaml Auto Router, Discord Rules Page, & Vi18n lib (#52) 2026-04-04 04:03:41 -04:00
pnpm-workspace.yaml wip: add db classes; can't load SQLite driver. 2025-09-10 17:55:28 -04:00
README.md Update README.md 2026-04-04 14:55:56 -04:00
stage.sh tweak: scripts 2026-02-09 20:30:40 -05:00
turbo.json fix: updated README instructions + fixed app running issues/cross-compatibility over operating systems 2025-06-10 21:10:55 -05: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

Core

Frontend

See atomic design principles for guidance on designing components.

Styling

  • Bulma - the primary stylesheet, which supports lots of basic elements simply. Prototyping is easy, since Bulma is built around applying classes to generic elements like div et al in order to achieve visual componentness
  • Tailwind CSS - Included supplimentarily: Bulma is opinionated and only maintained by one person, so we may discover it is inadequate for certain purposes. if necessary, we can use (or fully switch to) Tailwind.
  • Sass

Backend

Linting

Setup/Installation

  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. 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. 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 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.