Skip to content
/ astroplate Public template
forked from zeon-studio/astroplate

Astroplate is a free starter template built with Astro, TailwindCSS & TypeScript providing everything you need to jumpstart your Astro project. Get started with Astroplate and save yourself hours of work!

License

Notifications You must be signed in to change notification settings

malonge/astroplate

 
 

Repository files navigation

Astro + Tailwind CSS + TypeScript Starter and Boilerplate

Astroplate is a free starter template built with Astro, TailwindCSS & TypeScript, providing everything you need to jumpstart your Astro project and save valuable time.

Made with ♥ by Zeon Studio

If you find this project useful, please give it a ⭐ to show your support.

Astro Version 5.7 license code size contributors

📌 Key Features

  • 👥 Multi-Authors
  • 🌐 Multilingual
  • 🎯 Similar Posts Suggestion
  • 🔍 Search Functionality
  • 🌑 Dark Mode
  • 🏷️ Tags & Categories
  • 🔗 Netlify setting pre-configured
  • 📞 Support contact form
  • 📱 Fully responsive
  • 📝 Write and update content in Markdown / MDX
  • 📎 Google Tag Manager
  • 💬 Disqus Comment
  • 🔳 Syntax Highlighting

📄 15+ Pre-designed Pages

  • 🏠 Homepage
  • 👤 About
  • 📞 Contact
  • 👥 Authors
  • 👤 Author Single
  • 📝 Blog
  • 📝 Blog Single
  • 🚫 Custom 404
  • 💡 Elements
  • 📄 Privacy Policy
  • 🏷️ Tags
  • 🏷️ Tag Single
  • 🗂️ Categories
  • 🗂️ Category Single
  • 🔍 Search

🔗 Integrations

  • astro/react
  • astro/sitemap
  • astro/tailwind

🚀 Getting Started

📦 Dependencies

  • astro v5.7+
  • node v20.10+
  • yarn v1.22+
  • tailwind v4+

👉 Install Dependencies

yarn install

👉 Development Command

yarn run dev

👉 Build Command

yarn run build

👉 Build and Run With Docker

docker build -t astroplate .
# or
# docker --build-arg INSTALLER=npm build -t astroplate .
# or
# docker --build-arg INSTALLER=pnpm build -t astroplate .

docker run -p 3000:80 astroplate
# or
# docker run --rm -p 3000:80 astroplate

To access the shell within the container:

docker run -it --rm astroplate ash

📝 License

Copyright (c) 2023 - Present, Designed & Developed by Zeon Studio

Code License: Released under the MIT license.

Image license: The images are only for demonstration purposes. They have their license, we don't have permission to share those images.

Customization Notes

Here I will document how I (Michael Alonge) customized the Astroplate template to my personal website.

CV

The CV page combines a few key components:

The resume data is stored in src/config/cv.json and is treated as a configuration. This decouples the resume data from the resume template. Then I extended and customized the HTML/CSS template provided by Min–Zhong John Lu in src/styles/cv.css and src/pages/cv.astro to create a modern, print-optimized resume. By default, the cv page behaves like a normal website page and all of my resume content is embedded directly in the page. However, I added a print button to the page that allows the user to print the resume to a formatted PDF.

Route Validation

I added a route validation script to the project to ensure that the routes are generated correctly. This is done by checking the dist directory for the generated HTML files and comparing them to the expected routes.

To run the script, use the following command:

./scripts/validate-routes.sh

This script is also run as a GitHub Actions workflow to ensure that the routes are generated correctly before deployment. The GHA workflow is located in the .github/workflows/validate-routes.yml file.

About

Astroplate is a free starter template built with Astro, TailwindCSS & TypeScript providing everything you need to jumpstart your Astro project. Get started with Astroplate and save yourself hours of work!

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Astro 53.5%
  • CSS 18.3%
  • TypeScript 16.4%
  • JavaScript 8.5%
  • Shell 2.3%
  • Dockerfile 1.0%