joaopalmeiro / template-qwik-city-static

Opinionated Qwik City + SSG template for new projects.

template-qwik-city-static

Opinionated Qwik City + SSG template for new projects.

Getting Started

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

npx degit github:joaopalmeiro/template-qwik-city-static

or

npx degit github:joaopalmeiro/template-qwik-city-static --force

3. Search for template-qwik-city-static and replace it with the project name.
4. Search for Opinionated Qwik City + SSG template for new projects./Opinionated [Qwik City](https://qwik.dev/) + [SSG](https://qwik.dev/docs/deployments/static/) 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. Install fnm (if necessary).
7. Run the first two commands in the Development section to install Node.js and the development dependencies.
8. Open the NOTES.md file and install the project-specific dependencies according to the first command in the Commands section.
9. Search for https://yoursite.qwik.dev and replace it with the project domain.
10. Delete the Template References section from the NOTES.md file.
11. 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