Welcome to astro-starter
! This template is designed to kick-start your Astro project with a great configuration setup including ESLint, Prettier, Husky, CommitLint, lint-staged, and more. It follows best practices for development, ensuring your project is set up for consistency and maintainability from the start.
v18.18.0
8.11.0
astro-starter
is built with a carefully selected stack of technologies designed to provide an efficient, scalable, and developer-friendly experience. Here's what makes up our tech stack:
This stack is configured to offer a seamless development experience, focusing on performance and best practices.
Jumpstart your development with astro-starter
by setting up your project environment. Here's how to get everything ready:
To make things super easy, we've set up astro-starter
as a template repository. This means you can generate a new repository with the same directory structure and files. Follow these steps:
astro-starter
GitHub page and click on "Use this template".After creating your repository from the astro-starter
template, download or clone it to your local machine:
git clone https://github.com/<your-username>/<your-repository-name>.git
cd <your-repository-name>
Replace and with your GitHub username and the name of your newly created repository, respectively.
If you prefer to clone the repository directly, you can do so by running the following commands in your terminal:
git clone https://github.com/zyruks/astro-starter.git
cd astro-starter
Ensure you have PNPM installed, then execute the following command within your project directory to install all necessary dependencies:
pnpm install
Now that the dependencies are installed, initiate the development server to bring your project to life:
pnpm run dev
You're all set! Dive into the code and start building something amazing with astro-starter
. Happy coding!
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
pnpm install |
Installs dependencies |
pnpm run dev |
Starts local dev server at localhost:4321
|
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 |
pnpm run lint |
Lints the codebase for errors |
pnpm run format |
Formats the codebase using Prettier |
pnpm run astro ... |
Run CLI commands like astro add, astro check |
pnpm run astro -- |
--help Get help using the Astro CLI |
Interested in the code quality tools we use to maintain our project? Check out the documentation for each tool to learn more about how they contribute to our development process:
We welcome contributions to astro-starter
! Please read our CONTRIBUTING.md guidelines to learn how you can contribute to this project. Also, be sure to review our CODE_OF_CONDUCT.md and SECURITY.md to understand our community and security practices.
This project is licensed under MIT License. Feel free to clone, modify, and use it in your projects.