Installation

Installing Astro Template is easy. We will walk you through each steps to help you get started.

Step 1: Unzip the downloaded file. #

Once you have downloaded the template from our website, you will get a compressed *.zip file. You have to right-click the file and extract the contents to its own folder.

Inside the unzipped folder, you will see README, LICENSE & other assets along with the main template folder.

You can copy the template folder to your Project Folder and rename it as you need. Eg: the template folder can be astroship-pro and you can copy the folder to your project folder and can rename it as my-project or mywebsite.

Cloning from Github (optional) #

If you prefer cloning the repo from github, you can follow these steps.

If you downloaded a Free Template, you can view the product description page or README to get the public github repo link.

Once you visited that github link, you can click on the "Fork" button to copy the repository to your account. Then you can clone the repo to your system using the below command,

# clone inside `my-project` folder
git clone https://github.com/username/template-repo.git my-project
# or clone in the same directory
git clone https://github.com/username/template-repo.git .

If you purchased a Paid Template, First,you have to request access to our Private Github Repo. Fill up this form to get instant access.

Once you have access, you can follow the steps mentioned above to clone the project.

Project Structure: #

/
├── public/
│   └── ...
├── src/
│   ├── components/
│   │   └── ...
│   ├── layouts/
│   │   └── ...
│   └── pages/
│       └── ...
└── package.json

Step 2: Install Dependencies #

Use your favorite package manager (npm, yarn or pnpm) to install the dependencies. Use the following command in the terminal.

npm install
# or
yarn install
# or (recommended)
pnpm install

Step 3: Start Development #

Once you installed the dependencies, you can now run the following command to start development server at localhost.

npm run dev
# or
yarn dev
# or (recommended)
pnpm dev

If you setup everything correctly, you will now be able to view the template at http://localhost:4321. Open the link to view the template in your browser.

Keep the command open and it will automatically update the page when you save the files.

Step 4: Deployment #

Once you are happy with the changes you made, you can deploy the website to your favorite hosting providers. To Preview and build locally, you can use the following command.

npm run build
npm run preview

# or
yarn build
yarn preview

# or (recommended)
pnpm build
pnpm preview

The above command will build and preview the Astro Template locally.

You can push this code to github and can use websites like Vercel, Netlify or Cloudflare to host your website.

For a detailed guide, visit Official Astro Docs