This is the core repo for the informational website "viossa.net" (base domain) about the Viossa artificial pidgin language
Jezza Hehn
0db55d0e95
Deployment pipeline patch, related to "deployer" OS user and path weirdness, fingers crossed!! |
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| apps | ||
| libs/common | ||
| .gitattributes | ||
| .gitignore | ||
| .prettierrc | ||
| deploy.sh | ||
| package-lock.json | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| stage.sh | ||
| turbo.json | ||
| vite.config.ts | ||
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
divet 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
- Download and install Node.js and pnpm
- Open your favourite command line terminal
- Clone the repository:
git clone git@github.com:ViossaDiskordServer/ViossaDotNet.git - Move into the project's root directory:
cd ViossaDotNet - 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)
- Ensure you're in the root directory of the project (
ViossaDotNet) - Move into the app's directory:
cd apps/vdn-static - 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. - To view the website running locally, visit http://localhost:1224/ in your browser!
Backend (Viossa DB)
- Ensure you're in the root directory of the project (
ViossaDotNet) - Move into the app's directory:
cd apps/vdb-backend - To run the site, use
turbo start. This will build all of the app's dependencies and then start the application.- 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.
- To view a sample response from the backend API, visit http://localhost:1225/sample in your browser!