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