Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.08 KB

setting-up-the-project.md

File metadata and controls

55 lines (36 loc) · 2.08 KB

Setting Up The Project

  1. Setup Volta

If you are not already using ⚡️ volta or have a version older than 1.1.1 you will want to begin by installing it.

For package management, the project uses PNPM.

Volta will manage node and pnpm versions for you, but for PNPM there is one more step:

To your shell profile you will want to add the following.

export VOLTA_FEATURE_PNPM=1;

Note if you have previously installed pnpm globally via other means you should uninstall it from all other locations first. You may also need to uninstall nvm or other node version managers if they turn out to conflict.

  1. Install bun.sh

If you don't already have bun.sh For MacOS and Linux

curl -fsSL https://bun.sh/install | bash

can be done using homebrew, npm or Docker (User choice) checkout installation doc

For Windows

# WARNING: No stability is guaranteed on the experimental Windows builds
powershell -c "irm bun.sh/install.ps1|iex"

Installation doc

  1. Clone the repository
git clone git@github.com:emberjs/data.git
  1. Install the project dependencies
cd data && pnpm install

Currently the install command is also what builds all of the individual packages in the monorepo and hardlinks them together, so if making changes to one package that need to be used by another you will need to rerun pnpm install for the changes to be picked up.

  1. Run some commands

Generally test and lint commands can be found in the "scripts" section of the root package.json manifest. Individual packages or test packages have additional commands in the "scripts" section of their own package.json manifest as well.

Any command in script can be run using pnpm from the directory of that manifest. For instance, to run linting from the root: pnpm lint

Github Actions workflows will generally use these same commands.