Astro Boilerplate

Jairus Joer, 2024

The texts in this README were partially generated by artificial intelligence and corrected and revised by us.

Setup

Install the necessary dependencies to run the project locally using the node package manager of your choice:

npm install

Develop

To start the development server, simply run the following command:

npm run dev

Deploy

Simply run the following command and move the contents of ./dist/ to the root directory of your web server:

npm run build

Alternatively, the repository can be connected to providers such as Cloudflare or Vercel for automated deployment, eliminating the need for manual build and deployment.

Commands

Command	Action
npm install	Installs dependencies
npm run dev	Starts local dev server at localhost:3000
npm run build	Build your production site to ./dist/
npm run preview	Preview your build locally, before deploying
npm run astro ...	Run CLI commands like astro add, astro check
npm run astro -- --help	Get help using the Astro CLI
npm run prettier	Formats project code using Prettier

Resources

Please feel free to refer to the following documentation for more information and guidance:

• Alpine.js documentation
• Astro documentation
• TailwindCSS documentation