Back to Withastro

Prepare your dev environment

src/content/docs/en/tutorial/1-setup/1.mdx

latest3.3 KB
Original Source

import Checklist from '/components/Checklist.astro'; import Box from '/components/tutorial/Box.astro'; import MultipleChoice from '/components/tutorial/MultipleChoice.astro'; import Option from '/components/tutorial/Option.astro'; import PreCheck from '/components/tutorial/PreCheck.astro'; import { Steps } from '@astrojs/starlight/components'; import Badge from "/components/Badge.astro"

<PreCheck> - Install any tools that you will use to build your Astro website </PreCheck>

Get the dev tools you need

Terminal

You will use a command line (terminal) to create your Astro project and to run key commands to build, develop, and test your site.

You can access the command line through a local terminal program for your operating system. Common applications include Terminal (MacOS/Linux), Command Prompt (Windows), and Termux (Android). One of these will probably already be on your machine.

Node.js

For Astro to run on your system, you will also need to have a compatible version of Node.js installed. Astro supports even-numbered Node.js versions. The current minimum supported version is v22.12.0. Odd-numbered versions like v23 are not supported.

To check to see whether you already have a compatible version installed, run the following command in your terminal:

sh
node -v

// Example output
v22.20.0

If the command returns a version number supported by Astro, you're good to go!

If the command returns an error message like Command 'node' not found, or a version number lower than the required, then you need to install a compatible Node.js version.

Code Editor

Additionally, you will need to download and install a code editor to write your code.

:::tip[We'll use...] This tutorial will use VS Code, but you can use any editor for your operating system. :::

<Steps> 1. [Download and install VS Code](https://code.visualstudio.com/#alt-downloads) or another code editor of your choice. </Steps> <Box icon="question-mark">

Test your knowledge

Which of the following is...

  1. A code editor, for making changes to your files and their content?

    <MultipleChoice> <Option> web browser </Option> <Option> Terminal </Option> <Option isCorrect> VS Code </Option> </MultipleChoice>
  2. An online version control provider for your repository?

    <MultipleChoice> <Option isCorrect> GitHub </Option> <Option> Terminal </Option> <Option> VS Code </Option> </MultipleChoice>
  3. An application for running commands? <MultipleChoice>

    <Option> GitHub </Option> <Option isCorrect> Terminal </Option> <Option> web browser </Option> </MultipleChoice>
</Box> <Box icon="check-list"> ## Checklist for moving on <Checklist> - [ ] I can access the command line in a terminal. - [ ] I have Node.js installed. - [ ] I have a code editor like VS Code. </Checklist> </Box>

Resources

  • <p>[FreeCodeCamp.org](https://freecodecamp.org) <Badge class="neutral-badge" text="external" /> — a free educational site with full courses or quick refreshers in HTML, CSS, JS, and more.</p>