ScrewFast is an open-source template designed for quick and efficient web project setup, blending minimalism with functionality. Whether you're showcasing a portfolio, launching a company landing page, or running a blog, ScrewFast provides everything you need. By combining the power of the Astro, Tailwind CSS, and Preline UI, this template offers a functional and aesthetically pleasing solution for your web presence.
- Why Choose ScrewFast?
- Features
- Getting Started
- Deployment
- Project Structure
- Static Assets and Public Resources
- Customization
- Integrations and Enhancements
- Tools and Technologies
- Contributing
- License
- Efficient Architecture: Deploy faster with a template that's simple to set up and navigate.
- Optimized for Small Projects: Perfect for crisp, professional web personas without excess complexity.
- Highly Customizable: Flexibly adapt and style your site using Astro and Tailwind CSS.
- Astro-Powered: Utilize a modern static-site generation framework.
- Tailwind CSS: Enjoy rapid UI development with a utility-first CSS framework.
- Preline UI: Implement prebuilt UI components for added elegance.
- GSAP Integration: Impress with professional and polished animations.
- Markdown Content Collections: Organize and manage your content seamlessly.
- SEO and Responsiveness: Ensure your site is discoverable and accessible on any device.
This guide will provide you with the necessary steps to set up and familiarize yourself with the Astro project on your local development machine.
Start by installing the project dependencies. Open your terminal, navigate to the project's root directory, and execute:
npm install
This command will install all the necessary dependencies defined in the package.json
file.
With dependencies installed, you can utilize the following npm scripts to manage your project's development lifecycle:
npm run dev
: Starts a local development server with hot reloading enabled.npm run preview
: Serves your build output locally for preview before deployment.npm run build
: Bundles your site into static files for production.
For detailed help with Astro CLI commands, visit Astro's documentation.
Before deployment, you need to create a production build:
npm run build
This creates a dist/
directory with your built site (configurable via outDir in Astro).
Click the button below to start deploying your project on Vercel:
ScrewFast organizes modular components, content, and layouts to streamline development and content management. Expand for a detailed overview of the directory structure:
src/
├── components/ # Reusable components
│ ├── Meta.astro # Meta component for SEO
│ ├── sections/ # Components for various sections of the website
│ ├── ThemeIcon.astro # Component for toggling light/dark themes
│ └── ui/ # UI components categorized by functionality
├── content/ # Markdown files for blog posts, insights, products, and site configuration
│ ├── blog/
│ ├── insights/
│ ├── products/
│ └── config.ts # Contains site-wide configuration options
├── images/ # Static image assets for use across the website
├── layouts/ # Components defining layout templates
│ └── MainLayout.astro # The main wrapping layout for all pages
├── pages/ # Astro files representing individual pages and website sections
│ ├── 404.astro # Custom 404 page
│ ├── blog/
│ ├── contact.astro
│ ├── index.astro # The landing/home page
│ ├── insights/
│ ├── products/
│ ├── robots.txt.ts # Dynamically generates robots.txt
│ └── services.astro
└── utils/ # Shared utility functions and helpers
Static files served directly to the browser are within the public
directory at the root of the project. Expand for the layout:
public/
├── apple-touch-icon.png
├── favicon.ico
├── icon-192.png
├── icon-512.png
├── icon.svg
├── manifest.webmanifest
├── maskable_icon.png
├── maskable_icon_x512.png
├── scripts/
│ └── vendor/
│ ├── gsap/ # Animations powered by GSAP (GreenSock Animation Platform)
│ │ └── gsap.min.js
│ ├── lenis/ # Lenis script for smooth scrolling effects
│ │ └── lenis.js
│ └── preline/ # Preline UI plugins
│ ├── accordion/
│ ├── collapse/
│ ├── overlay/
│ └── tabs/
└── social.png # Image used for social media sharing previews
The scripts in the public/scripts/vendor
directory are essential for the interactivity and aesthetic features of the website. Do not remove these unless you plan to replace their functionality.
ScrewFast allows for easy customization to suit your specific needs. Here are a couple of ways you can configure components and content:
Some components have properties defined as TypeScript variables within the component file. Here's an example of customizing the FeaturesGeneral
component:
// Define the string variables title and subTitle for the main heading and sub-heading text.
const title: string = "Meeting Industry Demands";
const subTitle: string =
"At ScrewFast, we tackle the unique challenges encountered in the hardware and construction sectors.";
For collections of content like testimonials or statistics, edit the corresponding array of objects:
// An array of testimonials
const testimonials: Testimonial[] = [...];
// An array of statistics
const statistics: StatProps[] = [...];
Modify the content within these arrays to reflect your data.
You can pass values to props directly in the page files for components used across pages. Here's an example of a HeroSection
and ClientsSection
component with inline props:
<HeroSection
subTitle="Top-quality hardware tools and expert construction services for every project need."
primaryBtn="Start Exploring"
primaryBtnURL="/explore"
/>
<ClientsSection
title="Trusted by Industry Leaders"
subTitle="Experience the reliability chosen by industry giants."
/>
Edit the props such as title
, subTitle
, primaryBtn
, etc., to personalize these sections. Ensure that you maintain the structure and data types of the props.
Edit the navigation.ts
file within the utils
directory to manage navigation bar and footer links:
Edit the navBarLinks
array to adjust navigation bar links:
// An array of links for the navigation bar
export const navBarLinks: NavLink[] = [
{ name: "Home", url: "/" },
{ name: "Products", url: "/products" },
{ name: "Services", url: "/services" },
{ name: "Blog", url: "/blog" },
{ name: "Contact", url: "/contact" },
];
Replace name
with the display text and url
with the appropriate path to pages on your site.
Similarly, adjust the links displayed in the footer by editing the footerLinks
array:
// An array of links for the footer
export const footerLinks: FooterLinkSection[] = [
{
section: "Product",
links: [
{ name: "Tools & Equipment", url: "/tools-equipment" },
{ name: "Construction Services", url: "/construction-services" },
{ name: "Pricing", url: "/pricing" },
],
},
{
section: "Company",
links: [
{ name: "About us", url: "/about" },
{ name: "Blog", url: "/blog" },
{ name: "Careers", url: "/careers" },
{ name: "Customers", url: "/customers" },
],
},
];
Each section within the footerLinks
array represents a group of links. Update the section
value for the group heading and modify each link's name
and url
as needed.
Replace the placeholder URLs in the socialLinks
object with your social media profiles:
// An object of links for social icons
export const socialLinks: SocialLinks = {
facebook: "#",
twitter: "#",
github: "#",
linkedin: "#",
instagram: "#",
};
Note
Remember to add complete and valid URLs for the navigation to function properly. These customizations will reflect throughout your Astro site, promoting consistency across all pages.
ScrewFast leverages the power of Astro — a modern, cutting-edge site building framework — and integrates it seamlessly with the utility-first CSS framework TailwindCSS, to deliver exceptional site performance and a seamless user experience. Here are some notable integrations and enhancements included in the project:
Experience buttery smooth scrolling with Lenis. We've integrated Lenis to provide an enhanced scrolling experience that's both fluid and responsive.
Here's how we set up Lenis in src/layouts/MainLayout.astro
:
<script is:inline src="/scripts/vendor/lenis/lenis.js"></script>
<script is:inline>
// Script to handle Lenis library settings for smooth scrolling
const lenis = new Lenis({
smooth: true,
smoothTouch: false
});
function raf(time) {
lenis.raf(time); // Update Lenis on each animation frame
requestAnimationFrame(raf); // Continuously invoke the raf function at refresh rate
}
requestAnimationFrame(raf); // Start the loop
</script>
<style>
html.lenis {
height: auto;
}
.lenis.lenis-smooth {
scroll-behavior: auto !important;
}
.lenis.lenis-smooth [data-lenis-prevent] {
overscroll-behavior: contain;
}
.lenis.lenis-stopped {
overflow: hidden;
}
.lenis.lenis-scrolling iframe {
pointer-events: none;
}
</style>
Please note that smooth scrolling can affect accessibility and performance on some devices, so be sure to test it comprehensively across different environments.
Note
If you would like to remove Lenis and return to the browser's default scrolling behavior, simply comment out or delete these lines from the MainLayout.astro
file.
For individual product pages, GSAP has been integrated to add engaging animations that execute as soon as the product page loads. You can find and modify the GSAP configuration in the script sections of the product page file located at src/pages/products/[...slug].astro
:
<script is:inline src="/scripts/vendor/gsap/gsap.min.js"></script>
<script>
window.addEventListener("load", (event) => {
if (window.gsap) {
const gsap = window.gsap;
// Initialize GSAP animations...
}
});
</script>
Customizing Animations:
Please tailor the GSAP animations within this script to fit your project's look and feel. The provided example is a starting point, representing how to leverage GSAP for immediate visual impact as a product page loads.
Modifying or Removing Animations:
- To modify an animation, update the properties and parameters within the
gsap.from()
method, or add new GSAP animation calls as required. - Should GSAP not be needed, or if you prefer a different animation method, simply remove the aforementioned script segment.
Note
We've chosen to keep the integration lean and focused, but GSAP's comprehensive documentation can be referred to for more complex animations: GSAP Documentation.
To achieve a cleaner and more spacious design, the default scrollbar has been visually removed. While this choice fits the aesthetic goals of the project, it's important to consider that hiding scrollbars can sometimes affect accessibility and user experience. We recommend evaluating this design decision within the context of your user base and their needs.
For those who prefer custom-styled scrollbars, we suggest using the tailwind-scrollbar plugin, which adds Tailwind CSS utilities for scrollbar styles, allowing for more controlled customization that can also meet accessibility standards.
Note
If you wish to return the default scrollbar, you can comment out or remove the following CSS from src/layouts/MainLayout.astro
:
<style>
.scrollbar-hide::-webkit-scrollbar {
display: none;
}
.scrollbar-hide {
-ms-overflow-style: none;
scrollbar-width: none;
}
</style>
Additionally, update the <html>
tag to remove the scrollbar-hide
class, resulting in:
<html lang="en" class="scroll-pt-16">
The ScrewFast template incorporates a flexible SEO configuration that empowers you to effectively optimize each page for search engines as well as social media platforms. By utilizing the Meta.astro
component, you can easily customize important metadata such as page titles, descriptions, author information, and social media images to improve your site's visibility and engagement.
The Meta.astro
component is pre-configured with default metadata values that should be defined to align with your website's content, ensuring out-of-the-box SEO readiness. These defaults can be overridden on a per-page basis:
---
// In Meta.astro component
const defaultDescription = "ScrewFast offers top-tier hardware tools and expert construction services.";
const { meta = defaultDescription } = Astro.props;
---
By setting the defaultDescription
to a value that accurately reflects the content of your website, you ensure that all pages will have a relevant default meta description unless otherwise specified.
When applying metadata within your layouts, such as MainLayout.astro
, you can pass the desired metadata values as props to the Meta
component:
---
// In MainLayout.astro file
const { meta } = Astro.props;
interface Props {
meta?: string;
}
---
<Meta meta={meta} />
Finally, custom metadata can be passed to your layout component within individual page files, allowing for page-specific overrides:
---
// In your individual page file
import MainLayout from '../layouts/MainLayout.astro';
---
<MainLayout meta="Find the perfect hardware tools with ScrewFast for all your construction needs.">
<!-- Page content -->
</MainLayout>
With this setup, the Meta component receives the custom meta description and applies it to the page's metadata. If no custom value is passed, the default from Meta.astro
will be used instead.
For a more robust SEO strategy, you can create additional properties in the Meta.astro
component. For instance, you may want to include specific Open Graph tags for article publishing dates or tags for Twitter-specific metadata.
Structured data in JSON-LD format can be managed by the Meta.astro
component, improving how search engines understand your page content and potentially enhancing search results with rich snippets. Modify the structuredData
property with relevant schema.org types and properties:
<MainLayout
structuredData={{
"@context": "https://schema.org",
"@type": "WebSite",
"name": "ScrewFast",
"url": "https://screwfast.uk",
"description": "Discover top-quality hardware tools and services"
}}
>
While the template provides a custom SEO solution, you may choose to utilize an Astro integration such as Astro SEO for additional SEO features and optimizations. Integrating such a package might provide more automated metadata management and additional SEO-focused functionality.
robots.txt
is dynamically generated using the code found in src/pages/robots.txt.ts. This configuration follows the example from the Astro Docs:
import type { APIRoute } from 'astro';
const robotsTxt = `
User-agent: *
Allow: /
Sitemap: ${new URL('sitemap-index.xml', import.meta.env.SITE).href}
`.trim();
export const GET: APIRoute = () => {
return new Response(robotsTxt, {
headers: {
'Content-Type': 'text/plain; charset=utf-8',
},
});
};
Maximize your website's efficiency with these built-in Astro integrations:
- Astro Compressor: Automatically compresses Astro-generated site using gzip or brotli, ensuring faster load times.
Configure the compressor in
astro.config.mjs
file:
export default defineConfig({
// ...other Astro configurations
integrations: [...other Astro integrations, compressor({ gzip: false, brotli: true })],
});
- Astro Sitemap: Automatically generates a sitemap for a website, which is vital for SEO and helping search engine bots crawl pages effectively. To set up the Astro Sitemap, be sure to specify your site's base URL and any additional options in
astro.config.mjs
file:
export default defineConfig({
// ...
site: 'https://example.com',
integrations: [sitemap()],
});
The great thing about Astro is its rich ecosystem of integrations, allowing you to tailor project functionalities to your exact needs. Feel free to explore Astro integrations page and add additional capabilities as you see fit.
This project is built using a variety of tools and technologies that enhance its performance, maintainability, and developer experience. Below is a list of the key tools and their roles in the project:
Interactive components like navbars, modals, and accordions are built using Preline UI, a comprehensive open-source component library.
Styling across our project leverages the utility-first classes offered by Tailwind CSS. This methodology allows us to create custom layouts and components with speed and efficiency.
To ensure consistent code formatting, particularly for class sorting, we have integrated the prettier-plugin-tailwindcss
plugin. The following configuration is set in the .prettierrc
file at the root of the project:
{
"plugins": ["prettier-plugin-tailwindcss"]
}
We deploy our project on Vercel, capitalizing on their robust platform for seamless CI/CD workflows. Using vercel.json
, we set stringent security headers and caching policies, ensuring adherence to security and performance best practices:
{
"headers": [
{
"source": "/(.*)",
"headers": [
{
"key": "Content-Security-Policy",
"value": "default-src 'self'; [other-directives]"
},
"Additional security headers..."
]
}
]
}
For optimal site performance, we post-process our HTML files with process-html.mjs
, a custom script that minifies HTML after the build phase to reduce file size and improve load times.
Here is a snippet from our HTML minification script in process-html.mjs
:
/process-html.mjs
// Post-build HTML minification script snippet
// ...
await Promise.all(
files.map(async (file) => {
// File processing and minification logic
})
);
We encourage you to refer to the detailed documentation for each tool to fully understand their capabilities and how they contribute to the project:
- Preline UI Documentation
- Tailwind CSS Documentation
- Vercel Documentation
- html-minifier Documentation
If you're interested in helping, you can contribute in several ways:
- Reporting Issues: Feel free to use the issue tracker to report bugs or request features.
- Submitting Pull Requests: If you've fixed a bug or added a new feature, submit a pull request with a clear description of your changes.
- Providing Feedback: Share your thoughts on the project's current features and suggest improvements.
This project is released under the MIT License. Please read the LICENSE file for more details.