diff options
author | 2021-06-29 13:12:27 -0700 | |
---|---|---|
committer | 2021-06-29 13:12:27 -0700 | |
commit | 9c7921300c5aae35ee947be5fc515e5b3fdaf1a2 (patch) | |
tree | 94dc4d802341e827466f641de97acf74905c706c /docs/quick-start.md | |
parent | 4df98a79f8d5f14e9e049322a6eef2db4f985ae4 (diff) | |
parent | 279a25246260ef95459d29c8029b18bd89adc206 (diff) | |
download | astro-9c7921300c5aae35ee947be5fc515e5b3fdaf1a2.tar.gz astro-9c7921300c5aae35ee947be5fc515e5b3fdaf1a2.tar.zst astro-9c7921300c5aae35ee947be5fc515e5b3fdaf1a2.zip |
Merge branch 'docs-sync-1'
Diffstat (limited to 'docs/quick-start.md')
-rw-r--r-- | docs/quick-start.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/quick-start.md b/docs/quick-start.md new file mode 100644 index 000000000..f872e67b6 --- /dev/null +++ b/docs/quick-start.md @@ -0,0 +1,51 @@ +--- +layout: ~/layouts/Main.astro +title: Quick Start +--- + +```shell +# prerequisite: check that Node.js is 12.20.0+, 14.13.1+, or 16+ +node --version + +# create a new project directory, and `cd` into it +mkdir mkdirtest && cd "$_" + +# prepare for liftoff... +npm init astro + +# install dependencies +npm install + +# start developing! +npm run start + +# when you're ready: build your static site to `dist/` +npm run build +``` + +To deploy your Astro site to production, upload the contents of the `/dist` folder (generated by running `npm run build`) to your favorite hosting provider. + + + +## Start your project + +Go back to your command-line terminal, and run the following command in your project directory: + +```bash +npm start +``` + +Your application is now running on [http://localhost:3000](http://localhost:3000). Open this URL in your browser and you should see the text "Hello, World" that we copied in the previous step. + +Astro will listen for file changes in your `src/` directory, so you do not need to restart the application as you make changes during development. + + +## Build your project + +Go back to your command-line terminal, and run the following command in your project directory: + +```bash +npm run build +``` + +This will build your site and write it to disk in the `dist/` directory. Astro sites are static, so they can be deployed to your favorite host (Vercel, Netlify, an S3 bucket, etc.).
\ No newline at end of file |