joaopalmeiro / template-astro

Opinionated Astro template for new projects.

template-astro

Opinionated Astro template for new projects.

Getting Started

1. Go to or create the project folder.
2. Get the template files:

npx degit github:joaopalmeiro/template-astro

or

npx degit github:joaopalmeiro/template-astro --force

3. Search for template-astro and replace it with the project name.
4. Search for Opinionated Astro template for new projects./Opinionated [Astro](https://astro.build/) template for new projects. and replace it with the (short) project description.
5. Search for João Palmeiro and replace it with the author's name.
6. Search for [e-mail] and replace it with the author's email address.
7. Change the author.url field in the package.json file to the author's website/social media profile.
8. Install fnm (if necessary).
9. Run the first two commands in the Development section to install Node.js and the development dependencies.
10. Open the NOTES.md file and install the project-specific dependencies according to the first command in the Commands section.
11. Remove minimal-demo/ from the .gitignore file.
12. Delete the TEMPLATE.md file.
13. Delete the Getting Started section.

Development

Install fnm (if necessary).

fnm install && fnm use && node --version && npm --version

npm install

npm run dev

npm run lint

npm run format

Deployment

npm run build