Giter VIP home page Giter VIP logo

vrlabs.dev's Introduction

vrlabs.dev

Generic badge Generic badge

Homepage


Tech Stack

Frontend

  • Astro
  • Tailwind
  • Vanilla JS

Backend

  • .NET
  • Postgres
  • FastEndpoints

Other

Running locally

If you dont already have NVM installed, download the latest nvm-setup.zip from here, then extract the zip and run the installer.

If you are on a Unix based machine like Linux or MacOS, run the following command to install NVM:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

You can verify that NVM is installed by running:

nvm --version

After installing NVM run the following commands in the directory of the project:

  • nvm use to switch to the required Node version.
    • If the required version is not installed, you will be prompted to run the nvm install command.
    • After installing the required version, run nvm use again
  • npm install to install the dependencies

To start testing locally you can use the following commands:

  • npm run dev to start a local dev server at localhost:4321
  • npm run build to create a build of the website
  • npm run preview to preview the build at localhost:4321

If you are using VSCode you may be prompted to install some extensions which are recommended to be used when working on this project. If you are not using VSCode, please check if the most important extensions are available for your editor:

This step is optional but HIGHLY recommended.

Project Structure

The project is built on a vertical slice architecture, meaning every component is grouped with its related files.

root
├── public
├── src
│   ├── components
│   │   └── component
│   │       ├── file.astro
│   │       ├── file.css
│   │       └── file.js
│   ├── layouts
│   ├── pages
│   └── styles
└── package.json

The sub-directory pages is mandatory. Every astro html md and mdx file in this folder will be turned into an endpoint on the site corresponding to the file name.

Static assets like images or fonts can be placed in the public directory, as well as special files such as robots.txt and manifest.webmanifest. Do not place CSS or JS files here, as they will be excluded from the bundle and optimization processes.

The package.json file contains all dependencies and devDependencies of the project. Try not to install packages as devDependencies unless there is a specific reason to do so, as Astro only runs throgh all dependencies at build time and will not include packages from devDependencies in the final build.

vrlabs.dev's People

Contributors

hfcred avatar jellejurre avatar cibbi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.