Prismm Frontend Docs

Appearance

Getting Started ​

Installation ​

Prerequisites ​

  • Node.js version 18 or higher.
  • Yarn version 1.22 or higher (probably will work on lower specs).
  • Python any 3.x.x version.
  • VSCode is recommended, but Webstorm is also fine in a pinch.

Install ​

bash
yarn install

Running the app ​

bash
# development
yarn dev

# production
yarn build

How to add the SDK to your project ​

In the future you would need to run the following command in the terminal:

bash

yarn add @allseated-registry/framework

But right now you need to clone the repo and add it manually to your project, as it's not published to npm.

Q&A / FAQ ​

@allseated vs @allseated-registry ​

@allseated-registry is our npm registry, right now it's not public but the goal is for it to be, hence framework is in it. @allseated is our scope in the monorepo, it's not published to npm and it is not planned to be published to npm.

If you are using framework then it needs to be @allseated-registry/framework, but for every other package it's @allseated/package-name.

When should I run Yarn? ​

You should run yarn when you want to install a new package, or when you want to update a package. You should run yarn at the root of the monorepo, not in the app folder. This also means that you should run yarn when you pull from master (or other branches with major changes), because there might be new packages that you need to install.

What is a package.json file? ​

A package.json file is a JSON document that contains metadata about your project, such as its name, version, description, dependencies, scripts, and more. It is used by package managers like npm or yarn to install and manage your project’s dependencies, as well as to run scripts and commands.

How do I add a new package? ​

To add a new package, first find the packages name in npm, then in your app folder run:

bash

yarn add package-name

If it's a dev dependency, then run:

bash

yarn add package-name --dev

Alternatively you could also add it manually to the package.json file and run yarn install.

What is a dev dependency? ​

Sure, I can also explain that. A dev dependency is a module that is only required during development, such as testing frameworks, code formatters, linters, etc. A regular dependency is a module that is required at runtime, such as libraries, frameworks, utilities, etc.

Our Repo is setup with Turborepo, what is that? ​

Turborepo is a tool that allows us to work with multiple packages in a single repo. It also allows us to manage multiple npm packages in a single git repository. It's used mainly for monorepos, and allows for caching, parallelization, and more.

What is vite? ​

Vite is a build tool that serves our app during development. It aims to provide a faster and leaner development experience for modern web projects. We also use it to build our app for production.

How do I make it not refresh anytime I save? ​

In case you want to work on a feature that doesn't require the app to refresh, you can use the following command:

bash

yarn dev -c vite-config.nohmr.js

You can even run a version that doesn't automatically refresh and one that does at the same time by having another cmd open. They will run on different ports and you can access them through those ports.