https://github.com/ojdon/astro-tailwind-template

Boilerplate for starting a new static site.
https://github.com/ojdon/astro-tailwind-template

Last synced: about 1 month ago
JSON representation

Boilerplate for starting a new static site.

• Host: GitHub
• URL: https://github.com/ojdon/astro-tailwind-template
• Owner: ojdon
• Created: 2024-02-08T22:18:27.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-04-03T16:50:30.000Z (10 months ago)
• Last Synced: 2024-12-06T20:11:48.908Z (about 2 months ago)
• Language: Astro
• Size: 142 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Astro Tailwind Template

```sh

npm create astro@latest -- --template minimal

```

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/ojdon/astro-tailwind-template)

## 🚀 Project Structure

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

```text

/

├── public/

├── src/

│   └── 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:4321`      |

| `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).