https://github.com/bytrangle/astro-react

https://github.com/bytrangle/astro-react

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/bytrangle/astro-react
• Owner: bytrangle
• Created: 2023-02-09T11:20:11.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-09T11:39:29.000Z (over 3 years ago)
• Last Synced: 2024-10-14T11:03:30.335Z (over 1 year ago)
• Language: Astro
• Size: 95.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Astro React Starter Kit

Just a barebone Astro starter with React integration. No opinionated architecture or fancy feature.

[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/github/bytrangle/astro-react)

## 🚀 Project Structure

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

```

/

├── public/

│   └── favicon.svg

├── src/

│   ├── components/

│   │   └── Message.jsx

│   ├── 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).