Installation

Overview

There are a few different ways to use Polaris in your projects.

Polaris CDN

The easiest way to get started with Polaris is by importing its CDN links into your project.

Note! Polaris CDN is on the way and will be available soon.

Download Polaris

Another way to get started with Polaris is by downloading it:

https://github.com/heminsatya/polaris-core/releases

After downloading, put it inside line-lg your project public directory and unzip it.

Then all you need to do is to import Polaris CSS & JS libraries it into your website:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>My Website</title>
    <link rel="stylesheet" href="./polaris-core/dist/css/polaris.min.css">
</head>
<body>
    ...
    <script src="./polaris-core-x.x.x/dist/js/polaris.min.js"></script>
</body>
</html>

Well done! You get started with Polaris framework successfully. Now you can start using its components and features.

However, for using Polaris JavaScript library there are a few steps remained, which will be discussed later.

Install via npm

Another way to use Polaris is to install it via npm:

npm install polaris-core

Now, you may use it as the following:

<link rel="stylesheet" href="./node_modules/polaris-core/dist/css/polaris.min.css">
...
<script src="./node_modules/polaris-core/dist/js/polaris.min.js"></script>

However, this is not the best way to use it. If you only want to use Polaris in production, it"s much better to use its CDN or download it into your project.

Customize Polaris

If you want to use Polaris in both production and development, the best way is by customizing and bundling it with your existing libraries.

Normally, it is a complicated process and needs a high level of experience. But don"t worry we have created a few simple but very useful layouts that you can use as blueprints for customizing your code much easier. (Read More)