From 9c6a67a03b5c69e3d7b91d23ccfe32d972449929 Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Tue, 23 Aug 2022 21:37:36 -0400 Subject: [PATCH 01/10] Update README.md --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 42 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 42982ec..f2c7cfd 100644 --- a/README.md +++ b/README.md @@ -7,20 +7,20 @@ A template to make your website using **Astro + Tailwind CSS**. Ready to start a **Features** -- Excellent integration with **Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/). -- Support for fast and **SEO friendly Blog**. -- Automatic **RSS feed** generation with [@astrojs/rss](https://docs.astro.build/en/guides/rss/). -- **Image optimization** using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/). Supports resizing images and encoding them to different image formats. -- Automatically generate the **project sitemap** based on your routes with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/). -- **Optimize the use of fonts** from Google Fonts at build time with [subfont](https://www.npmjs.com/package/subfont) library. -- **Production-ready** scores in Lighthouse and PageSpeed Insights reports: - - 100 Performance, 100 Accessibility, 100 Best Practices, 100 SEO +- Integration with **Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/) +- Support for **fast and SEO friendly Blog** with automatic **RSS feed** with [@astrojs/rss](https://docs.astro.build/en/guides/rss/). +- **Image optimization** using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/). +- Generation of **project sitemap** based on your routes with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/). +- It supports **Dark mode** +- **Open Graph tags** for social media sharing +- **Fonts optimization** build time with [subfont](https://www.npmjs.com/package/subfont) library. +- **Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports
AstroWind Theme Screenshot - -[Live demo](https://astrowind.vercel.app/) + +[Live demo](https://astrowind.vercel.app/)
@@ -71,6 +71,8 @@ There's nothing special about `src/components/`, but that's where we like to put 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. +[![Edit AstroWind on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://githubbox.com/onwidget/astrowind/tree/main) + > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
@@ -88,6 +90,30 @@ All commands are run from the root of the project, from a terminal:
+## Deploy + +### Deploy to production (manual) + +You can create an optimized production build with: + +```shell +npm run build +``` + +Now, your blog 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: + +[![Netlify Deploy button](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/onwidget/astrowind) + +
+ ## Roadmap - *Config*: Move specific configurations to a specialized file @@ -100,6 +126,10 @@ All commands are run from the root of the project, from a terminal:
-## Want more? +## Contributing -If you have any suggestions or find any bugs, feel free to [open an issue](https://github.com/onwidget/astrowind/issues) or [create a pull request](https://github.com/onwidget/astrowind/pulls). +If you have any suggestions or find any bugs, feel free to open an issue or create a pull request. + +## License + +**AstroWind** is licensed under the MIT license — see the [LICENSE](https://github.com/onwidget/astrowind/blob/main/LICENSE) file for details. From fa7804f9efc0461f00fb9dcca0f087c9dceb01a2 Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Tue, 23 Aug 2022 21:40:26 -0400 Subject: [PATCH 02/10] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f2c7cfd..480c6fc 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,14 @@ A template to make your website using **Astro + Tailwind CSS**. Ready to start a **Features** -- Integration with **Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/) -- Support for **fast and SEO friendly Blog** with automatic **RSS feed** with [@astrojs/rss](https://docs.astro.build/en/guides/rss/). -- **Image optimization** using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/). -- Generation of **project sitemap** based on your routes with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/). -- It supports **Dark mode** -- **Open Graph tags** for social media sharing -- **Fonts optimization** build time with [subfont](https://www.npmjs.com/package/subfont) library. -- **Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports +- ✅ Integration with **Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/) +- ✅ Support for **fast and SEO friendly Blog** with automatic **RSS feed** with [@astrojs/rss](https://docs.astro.build/en/guides/rss/). +- ✅ **Image optimization** using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/). +- ✅ Generation of **project sitemap** based on your routes with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/). +- ✅ It supports **Dark mode** +- ✅ **Open Graph tags** for social media sharing +- ✅ **Fonts optimization** build time with [subfont](https://www.npmjs.com/package/subfont) library. +- ✅ **Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports
From f1edd62c47d77ed5a958fbca89a9b69641c3b3c9 Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Tue, 23 Aug 2022 21:43:09 -0400 Subject: [PATCH 03/10] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 480c6fc..5e7dafb 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ 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. +**AstroWind** is a free and opensource template to make your website using **Astro + Tailwind CSS**. Ready to start a new project and designed taking into account best practices. -**Features** +Features: - ✅ Integration with **Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/) - ✅ Support for **fast and SEO friendly Blog** with automatic **RSS feed** with [@astrojs/rss](https://docs.astro.build/en/guides/rss/). From fad91f3dc3cbab3529b13cdce7c8822be501c32c Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Tue, 23 Aug 2022 21:52:16 -0400 Subject: [PATCH 04/10] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5e7dafb..c7b70cf 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,17 @@ AstroWind Lighthouse Score -**AstroWind** is a free and opensource template to make your website using **Astro + Tailwind CSS**. Ready to start a new project and designed taking into account best practices. +**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** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/) -- ✅ Support for **fast and SEO friendly Blog** with automatic **RSS feed** with [@astrojs/rss](https://docs.astro.build/en/guides/rss/). -- ✅ **Image optimization** using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/). -- ✅ Generation of **project sitemap** based on your routes with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/). -- ✅ It supports **Dark mode** +- ✅ Integration with **Tailwind CSS** ([@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)). +- ✅ Supports **Dark mode**. +- ✅ **Fast and SEO friendly blog** with automatic **RSS feed** ([@astrojs/rss](https://docs.astro.build/en/guides/rss/)). +- ✅ **Image optimization** ([@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/)). +- ✅ Generation of **project sitemap** based on your routes ([@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)). - ✅ **Open Graph tags** for social media sharing -- ✅ **Fonts optimization** build time with [subfont](https://www.npmjs.com/package/subfont) library. +- ✅ **Fonts optimization** at build time ([subfont](https://www.npmjs.com/package/subfont)). - ✅ **Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports
From e3c41b9bfe410c2269bb430c54eebb4d61fa451a Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Tue, 23 Aug 2022 23:23:28 -0400 Subject: [PATCH 05/10] Update README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c7b70cf..e46d65a 100644 --- a/README.md +++ b/README.md @@ -100,18 +100,22 @@ You can create an optimized production build with: npm run build ``` -Now, your blog is ready to be deployed. All generated files are located at +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: [![Netlify Deploy button](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/onwidget/astrowind) +### Deploy to Vercel + +Clone this repository on own GitHub account and deploy to Vercel: + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fonwidget%2Fastrowind) +
## Roadmap From 77f48f0d52a2285a6bedb03b5cb6a77a70f494dd Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Wed, 24 Aug 2022 01:48:20 -0400 Subject: [PATCH 06/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e46d65a..2c9acdb 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ **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: +## Features - ✅ Integration with **Tailwind CSS** ([@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)). - ✅ Supports **Dark mode**. From 7de410bfbd353c3265dd4a99cb86ebc14dd89c3c Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Wed, 24 Aug 2022 11:35:42 -0400 Subject: [PATCH 07/10] Update README.md --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2c9acdb..21dac7c 100644 --- a/README.md +++ b/README.md @@ -121,10 +121,21 @@ Clone this repository on own GitHub account and deploy to Vercel: ## 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 ...)~~ +- *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 +- *SEO*: + - **(DONE)** Add support to easily manage SEO meta-tags (title, description, canonical, social sharing, ...) +- *Blog*: + - **(DONE)** Support to Fast and SEO friendly blog + - Improve blog design + - Add support for categories and tags. + - 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 @@ -132,7 +143,8 @@ Clone this repository on own GitHub account and deploy to Vercel: ## Contributing -If you have any suggestions or find any bugs, feel free to open an issue or create a pull request. +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. ## License From c4e389d5200c0ff90439afba69ac63752df12846 Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Wed, 24 Aug 2022 11:46:15 -0400 Subject: [PATCH 08/10] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21dac7c..d14b8ab 100644 --- a/README.md +++ b/README.md @@ -118,12 +118,13 @@ Clone this repository on own GitHub account and deploy to Vercel:
-## Roadmap +## Roadmap 1.0 -- *Config*: Move specific configurations to a specialized file - *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 - *SEO*: - **(DONE)** Add support to easily manage SEO meta-tags (title, description, canonical, social sharing, ...) - *Blog*: From 7028661f0a274b0ea7b9d163e6aae82ae9502728 Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Wed, 24 Aug 2022 12:39:33 -0400 Subject: [PATCH 09/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d14b8ab..2cd0d65 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ Clone this repository on own GitHub account and deploy to Vercel:
-## Roadmap 1.0 +## Roadmap v1.0 - *Project*: - **(DONE)** Reduce the complexity in the components folder and simplify the other folders to make it very easy to use. From c60b9898faaae9e5d53fb70b46c2aa2e7645fc3f Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Wed, 24 Aug 2022 16:32:29 -0400 Subject: [PATCH 10/10] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2cd0d65..e6ee2a7 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,7 @@ Clone this repository on own GitHub account and deploy to Vercel: - 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*: