How to Use the EBRAINS UI Monorepo

Clone the Repository

Clone the entire repository from your version control system:

If you encounter permission issues when cloning the repository, try including your GitLab username in the URL. For example:

Replace your-gitlab-username with your actual EBRAINS GitLab username. When you run the command, you’ll be prompted to enter your password. For authentication, use your personal access token. You can create one here: GitLab Personal Access Tokens

Change Directory

Make sure you are in the right directory

Install Nx

Install the Nx CLI globally if you haven’t already:

Verify Installation

Check that Nx is installed correctly by verifying the version:

Choose the right Node and NPM versions

Make sure you have Node.js and npm installed on your machine before proceeding. Check the active engines in the global package.json and use the defined versions. We recommend installing and using the Node Version Manager (NVM) to easily switch between Node versions.

If the versions do not match the ones defined in package.json, use NVM to install and switch to the correct version:

Install Dependencies

From root ebrains-ui-ecosystem % Install all necessary npm packages for the project.

Test a Consumer Application (optional)

To serve a test application locally using the following commands, depending on the application, you may need to build the components library first. So let’s do this.

Now that the components are built and available, run:

You should see: