Giter Club home page Giter Club logo

astrowind's Introduction

AstroWind Template

AstroWind Lighthouse Score

A template to make your website using Astro + Tailwind CSS. Ready to start a new project and designed taking into account best practices.

๐Ÿš€ Features

  • Excellent integration with Tailwind CSS via @astrojs/tailwind.
  • Support for fast and SEO friendly Blog.
  • Automatic RSS feed generation with @astrojs/rss.
  • Image optimization using @astrojs/images. Supports resizing images and encoding them to different image formats.
  • Automatically generate the project sitemap based on your routes with @astrojs/sitemap.
  • Optimize the use of fonts from Google Fonts at build time with subfont library.
  • Production-ready scores in Lighthouse and PageSpeed Insights reports:
    • 100 Performance, 100 Accessibility, 100 Best Practices, 100 SEO

AstroWind Theme Screenshot

Live demo


๐Ÿ“— Project Structure

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

/
โ”œโ”€โ”€ public/
โ”‚   โ”œโ”€โ”€ robots.txt
โ”‚   โ””โ”€โ”€ favicon.ico
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ”‚   โ”œโ”€โ”€ images/
|   |   โ””โ”€โ”€ styles/
|   |       โ””โ”€โ”€ base.css
โ”‚   โ”œโ”€โ”€ data/
|   |   โ””โ”€โ”€ posts/
|   |       โ””โ”€โ”€ post-1.md
|   |       โ””โ”€โ”€ ...
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”œโ”€โ”€ core/
|   |   โ”œโ”€โ”€ icons/
|   |   โ””โ”€โ”€ widgets/
|   |       โ””โ”€โ”€ Header.astro
|   |       โ””โ”€โ”€ Footer.astro
|   |       โ””โ”€โ”€ ...
โ”‚   โ”œโ”€โ”€ layouts/
โ”‚   |   |โ”€โ”€ Base.astro
โ”‚   |   โ””โ”€โ”€ ...
โ”‚   โ”œโ”€โ”€ pages/
โ”‚   |   โ”œโ”€โ”€ blog/
โ”‚   |   โ”œโ”€โ”€ index.astro
|   |   โ””โ”€โ”€ 404.astro
โ”‚   โ””โ”€โ”€ utils/
โ””โ”€โ”€ 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 folder 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

๐Ÿšง Roadmap

  • Config: Move specific configurations to a specialized file
  • Project structure: Reduce the complexity in the components folder and simplify the other folders to make it very easy to use. (DONE! Testing)
  • SEO: Add support to easily manage SEO meta-tags (title, description, canonical, social sharing, ...) (DONE! Testing)
  • Blog: Add support for fast, accessible, and SEO friendly blog (DONE! Testing)
  • More components: Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs ...)
  • More Examples: Add commonly used example pages (Ex: About, Terms, Services...)
  • Documentation: Create detailed documentation with best practices and redesign tips

๐Ÿ‘€ Want more?

If you have any suggestions or find any bugs, feel free to open an issue or create a pull request.

astrowind's People

Contributors

prototypa avatar wppoland avatar berkaycubuk avatar

Stargazers

Nikola Hristov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.