Skip to main content

Local link setup

In this section, you will find an explanation of how to setup Atlas link locally.

Package.json​

We assume you are using our library in your project this way:

"dependencies": {
    "@adjust/components": "^6.26.0"
}

Authentication​

As the design system packages are private make sure that you're authenticated. For more information follow this guide.

Clone​

You need to clone the Atlas repo locally,

cd <project folder>
git clone https://github.com/adjust/atlas.git

Got to Atlas and Install all the dependencies

cd atlas
yarn

Go the local Atlas module to label them for link.

cd packages/components

Create the latest build. Make sure to have a compatible Node.js and Yarn version installed. You can find these under the engines key in the root package.json

yarn run build

Finally link it. If you use npm in your project (make sure node version is the same). If your project uses node v16 you need to create a link using the same version.

npm link

If you use yarn in your project

yarn link

Optional, if you like to see the changes made on Atlas on the go on your project, you need to keep Atlas running.

yarn start

Now, go the your project where you are using Atlas package.

if you use yarn

cd <project folder>/my-project
yarn link @adjust/components

if you use npm

cd <project folder>/my-project
npm link @adjust/components

Package.json​

Now your project's package.json will be pointing to the version you cloned :

"dependencies": {
    "@adjust/components": "^6.30.1"
}

Run Project​

Finally, all set. Run your project and you should see new changes imported from local Atlas package. If any breaking changes, check our Releases page for the changes.