https://github.com/xetera/xetera.dev

📚 A place for my ramblings
https://github.com/xetera/xetera.dev

Last synced: about 1 year ago
JSON representation

📚 A place for my ramblings

• Host: GitHub
• URL: https://github.com/xetera/xetera.dev
• Owner: Xetera
• Created: 2020-07-09T03:17:35.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-11T00:40:22.000Z (about 2 years ago)
• Last Synced: 2024-05-06T12:27:04.119Z (about 2 years ago)
• Language: MDX
• Homepage: https://simp.engineer
• Size: 93.4 MB
• Stars: 93
• Watchers: 3
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Astro Starter Kit: Basics

```

npm create astro@latest -- --template basics

```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)

[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/basics)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

![basics](https://user-images.githubusercontent.com/4677417/186188965-73453154-fdec-4d6b-9c34-cb35c248ae5b.png)

## 🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

```

/

├── public/

│   └── favicon.svg

├── src/

│   ├── components/

│   │   └── Card.astro

│   ├── layouts/

│   │   └── Layout.astro

│   └── pages/

│       └── index.astro

└── package.json

```

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command                | Action                                           |

| :--------------------- | :----------------------------------------------- |

| `npm install`          | Installs dependencies                            |

| `npm run dev`          | Starts local dev server at `localhost:3000`      |

| `npm run build`        | Build your production site to `./dist/`          |

| `npm run preview`      | Preview your build locally, before deploying     |

| `npm run astro ...`    | Run CLI commands like `astro add`, `astro check` |

| `npm run astro --help` | Get help using the Astro CLI                     |

## 👀 Want to learn more?

Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).