Installation on MacOS

To install the URSYS Build Framework, you'll need to have git and nvm already installed as per the Installation docs.

1. Clone Repo and Prepare Project

1. Open a terminal window, then cd to your developer directory, then clone [email protected]:dsriseah/ursys.git.
2. In the terminal mv ursys.code-workspace-example ursys.code-workspace

Next, open Visual Studio code (VSCODE) and then use "Open Workspace" (in FILE menu) open the ursys.code-workspace project file.

By using the .code-workspace file to open the project, you enable VSCODE-specific scripts that help detect environment issues. These scripts only run within VSCODE when opening an integrated terminal window. It also forces some developer conventions.

2. Install Recommended VSCODE Extensions

You may see a popup inviting you to install recommended extensions for this project. For the intended developer experience, please install them. They're also listed in the .vscode/extensions.json file if you don't see the popup. This enables stuff like Intellisense, Live Editor Linting.

3. First-Time Setup

• In VSCode, type ctrl ~ (tilde) to open the integrated terminal.
• cat .nvmrc to see what version of NodeJS is required by ursys; for this example it will be v18.18.2.
• Install required node version with nvm (e.g. nvm install v18.18.2)
• Set the correct node version in-use (e.g. nvm use v18.18.2)
• Do a QUIT and RESTART of VSCode

After restarting VSCODE, open the integrated terminal again and run:

• npm ci

That's it! Now you can run the example app.

4. Quick Testing

There's a default project that you can run from the root level ofthe project.

• npm run example
• open http://localhost:3000 in a browser

You can modify the files in example and see what happens.

You can also try the URSYS command runner ur, which you can get to from the _ur subdirectory.

• cd _ur
• ur

Tip

If it doesn't work, check that you opened the project via the .code-workspace file you copied in step 1.

There are several URSYS "addons" that live in the _ur_addons directory.

• Try running ur midi for an example MIDI piano browser app.
• Try running ur net start in one terminal window, make another terminal window and run ur net hosts then ur net stop.

For more introductory detail, see Basics: Using URSYS