🚀 AstroWind

Sept 08 2022

🚀 AstroWind

AstroWind Lighthouse Score

AstroWind is a free and open-source template to make your website using Astro + Tailwind CSS. Ready to start a new project and designed taking into account best practices.

Features

✅ Integration with Tailwind CSS (@astrojs/tailwind).
✅ Supports Dark mode.
✅ Fast and SEO friendly blog with automatic RSS feed (@astrojs/rss) and MDX support.
✅ Image optimization (@astrojs/images).
✅ Generation of project sitemap based on your routes (@astrojs/sitemap).
✅ Open Graph tags for social media sharing
✅ Fonts optimization at build time (subfont).
✅ Production-ready scores in Lighthouse and PageSpeed Insights reports

Table of Contents

Demo
Getting started
Roadmap
Frequently Asked Questions
Contributing
Acknowledgements
License

Demo

🌀 astrowind.vercel.app

Getting started

Project structure

Inside AstroWind template, you’ll see the following folders and files:

/
├── data/
|   └── blog/
|       ├── post-slug-1.md
|       ├── post-slug-2.mdx
|       └── ...
├── public/
│   ├── robots.txt
│   └── favicon.ico
├── src/
│   ├── assets/
│   │   ├── images/
|   |   └── styles/
|   |       └── base.css
│   ├── components/
│   │   ├── atoms/
│   │   ├── blog/
│   │   ├── core/
|   |   └── widgets/
|   |       ├── Header.astro
|   |       ├── Footer.astro
|   |       └── ...
│   ├── layouts/
│   |   |── BaseLayout.astro
│   |   └── ...
│   ├── pages/
│   |   ├── [...blog]/
|   |   |   ├── [...page].astro
|   |   |   └── [slug].astro
│   |   ├── [...categories]/
|   |   |   └── [category]/
|   |   |       └── [...page].astro
│   |   ├── [...tags]/
|   |   |   └── [tag]/
|   |   |       └── [...page].astro
│   |   ├── index.astro
|   |   ├── 404.astro
|   |   └-- rss.xml.js
│   ├── utils/
│   └── config.mjs
├── 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 if they do not require any transformation or in the assets/ directory if they are imported directly.

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

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

Configuration

Basic configuration file: ./src/config.mjs

export const SITE = {
  name: "Example",

  origin: "https://example.com",
  basePathname: "/", // Change this if you need to deploy to Github Pages, for example

  title: "Example - This is the homepage title of Example",
  description: "This is the homepage description of Example",

  googleAnalyticsId: false, // or "G-XXXXXXXXXX",
  googleSiteVerificationId: false // or some value,
};

export const BLOG = {
  disabled: false,
  postsPerPage: 4,

  blog: {
    disabled: false,
    pathname: 'blog', // blog main path, you can change this to "articles" (/articles)
  },

  post: {
    disabled: false,
    pathname: '', // empty for /some-post, value for /pathname/some-post 
  },

  category: {
    disabled: false,
    pathname: 'category', // set empty to change from /category/some-category to /some-category
  },

  tag: {
    disabled: false,
    pathname: 'tag', // set empty to change from /tag/some-tag to /some-tag
  },
};

Deploy

Deploy to production (manual)

You can create an optimized production build with:

npm run build

Now, your website is ready to be deployed. All generated files are located at dist folder, which you can deploy the folder to any hosting service you prefer.

Deploy to Netlify

Clone this repository on own GitHub account and deploy to Netlify:

Deploy to Vercel

Clone this repository on own GitHub account and deploy to Vercel:

Roadmap

Project:
- (DONE) Reduce the complexity in the components folder and simplify the other folders to make it very easy to use.
- Create simple and clear strategy to get template updates
- Move specific configurations to a specialized file
- Fix some bugs with prettier
- Make the use of images clean and intuitive
SEO:
- (DONE) Add support to easily manage SEO meta-tags (title, description, canonical, social sharing, …)
Blog:
- (DONE) Support to Fast and SEO friendly blog
- (DONE) Add support for categories and tags.
- Improve blog design
- Create component or utilities for latest posts
- Create component or utilities for related posts
- Add more shortcodes or embed functions to posts in Markdown: (eg video, tweet…)
More widgets:
- ~~Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs …)~~
- Create external library or place with useful Tailwind components
More Examples: Add commonly used example pages (Ex: About, Terms, Services…)
Documentation: Create detailed documentation with best practices and redesign tips

Frequently Asked Questions

Why?

Contributing

If you have any idea, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request. That would be very useful for all of us and we would be happy to listen and take action.

Acknowledgements

Initially created by onWidget and maintained by a community of contributors.

License

AstroWind is licensed under the Unlicense license — see the LICENSE file for details.