Skip to content

A simple Astro boilerplate with CUBE CSS and TailwindCSS

Notifications You must be signed in to change notification settings

rol4nd909/astro-cube-tw-boilerplate

Repository files navigation

A simple Astro boilerplate with CUBE CSS and TailwindCSS

Introduction

This project is a boilerplate designed to kickstart your development process. It combines the power of Astro, a web framework for content-driven websites, Cube CSS, a pragmatic and simple CSS methodology, Every Layouts, for better, more resilient CSS, and Tailwind CSS, a utility-first CSS framework used as utility-second. It also incorporates design tokens for consistent styling. The project uses pnpm for efficient package management.

By using this boilerplate, you can leverage the benefits of these technologies right from the start, without the hassle of setting them up individually. This can significantly speed up your development process, ensure code quality, and ultimately lead to a better end product. It's perfect for teams that value efficiency, performance, and modern development practices.

For more information, you can read Andy Bell's A CSS project boilerplate.

Features

  • Pre-configured Astro, CubeCSS, Every Layouts, Tailwind CSS, and pnpm setup
  • Pragmatic and simple CSS methodology with CubeCSS
  • Better, more resilient CSS with Every Layouts
  • Utility-first CSS with Tailwind used as utility-second
  • Consistent styling with design tokens
  • Efficient package management with pnpm
  • Fast and modern websites with Astro

Requirements

  • Node.js and pnpm installed on your local machine

Installation

  1. Clone the repository to your local machine
  2. Navigate to the root of the project directory in a terminal
  3. Run the following commands:
Command Action
pnpm install Installs dependencies
pnpm run dev Starts local dev server at localhost:4321

For other actions, you can use the following commands:

Command Action
pnpm run build Build your production site to ./dist/
pnpm run preview Preview your build locally, before deploying
pnpm run astro ... Run CLI commands like astro add, astro check
pnpm run astro -- --help Get help using the Astro CLI

Usage

After running the development server, you can start building your project in the src directory. The changes will be automatically reflected in your local server.

Contributing

Contributions are welcome! Please read the contributing guidelines before making any changes. If you're planning to contribute, please create a new branch for your feature or bug fix and submit a pull request on GitHub. This will make it easier to review and merge your changes.

Contact

For further questions or support, please contact [email protected]. You can also reach out through GitHub by opening an issue or a discussion.

About

A simple Astro boilerplate with CUBE CSS and TailwindCSS

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published