Introduction

Astroship is a versatile starter template designed for startups, marketing websites, landing pages, and blogs. Created by surjithctly, this template leverages the power of Astro and TailwindCSS to provide a robust foundation for building modern web projects. Astroship offers a free version with essential features and a pro version with advanced capabilities, making it suitable for various project needs.

Main Features

• Built with Astro v3 and TailwindCSS
• Content Collections for efficient content management
• Mobile-responsive design
• Working contact page
• Free updates
• Blog functionality (pagination in Pro version)
• View Transitions (Pro version)
• Advanced homepage design (Pro version)
• Features and Integrations pages (Pro version)
• 6 months support (Pro version)

Installation Steps

1. Clone the repository:

   git clone https://github.com/surjithctly/astroship.git myProjectName
   

   or

   git clone https://github.com/surjithctly/astroship.git .
   

2. Install dependencies:

   pnpm install
   

   (npm and yarn are also supported)

3. Start the development server:

   pnpm dev
   

4. For production build:

   pnpm build
   

5. To preview the production build:

   pnpm preview
   

Usage Instructions

1. Project Structure:

   • public/: Store static assets like images
   • src/components/: Contains reusable components
   • src/layouts/: Holds page layouts
   • src/pages/: Contains .astro or .md files for each page

2. Creating Pages:

   • Add new .astro or .md files in the src/pages/ directory

3. Styling:

   • Use TailwindCSS classes for styling components and pages

4. Content Management:

   • Utilize Astro's Content Collections for efficient content organization

5. Customization:

   • Modify existing components in src/components/
   • Create new components as needed
   • Adjust layouts in src/layouts/ to fit your design requirements

6. Blog Posts:

   • Add blog posts as .md files in the appropriate content collection directory

7. Deploying:

   • Use the provided deploy buttons for quick deployment to Vercel or Netlify
   • Alternatively, follow your hosting provider's deployment instructions

Important Notes

1. The free version has limitations compared to the pro version. Review the feature comparison before deciding which version suits your needs.

2. Astroship is built with Astro v3, ensuring compatibility with the latest Astro features and optimizations.

3. The template is mobile-responsive, but always test your customizations across various devices and screen sizes.

4. While the free version is under the GPL-3.0 license, the pro version comes with a commercial license.

5. Regular updates are provided for both free and pro versions. Keep your project updated to benefit from the latest improvements.

6. The pro version offers 6 months of support, which can be valuable for complex projects or if you need assistance with customizations.

7. Astroship uses pnpm as the recommended package manager, but npm and yarn are also supported.

8. Leverage Astro's built-in optimizations for performance, such as partial hydration and static site generation.

9. The project structure follows Astro's conventions, making it easy to understand and extend for developers familiar with Astro.

10. Always refer to the official Astro documentation for best practices and advanced usage of Astro features.