{"id":32613852,"url":"https://github.com/rezozero/nuxt-starter","last_synced_at":"2025-10-30T15:55:07.819Z","repository":{"id":40757439,"uuid":"383178708","full_name":"rezozero/nuxt-starter","owner":"rezozero","description":"Starter template for Nuxt project","archived":false,"fork":false,"pushed_at":"2025-10-23T07:14:37.000Z","size":12295,"stargazers_count":14,"open_issues_count":21,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-10-23T09:13:49.651Z","etag":null,"topics":["javascript","nuxt","nuxt3","nuxtjs","roadiz","starter","starter-kit","typescript","website"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rezozero.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-07-05T15:01:52.000Z","updated_at":"2025-10-23T07:13:06.000Z","dependencies_parsed_at":"2024-03-22T16:43:23.953Z","dependency_job_id":"fc4360f9-43d1-474b-89e3-524b5f12fb00","html_url":"https://github.com/rezozero/nuxt-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rezozero/nuxt-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rezozero%2Fnuxt-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rezozero%2Fnuxt-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rezozero%2Fnuxt-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rezozero%2Fnuxt-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rezozero","download_url":"https://codeload.github.com/rezozero/nuxt-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rezozero%2Fnuxt-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281835582,"owners_count":26569857,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-30T02:00:06.501Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","nuxt","nuxt3","nuxtjs","roadiz","starter","starter-kit","typescript","website"],"created_at":"2025-10-30T15:55:00.429Z","updated_at":"2025-10-30T15:55:07.804Z","avatar_url":"https://github.com/rezozero.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nuxt starter\n\n## Application overview\n\n- Nuxt as framework\n- Vite for development and build\n- SCSS for styles\n- Typescript for scripts\n- PNPM as package manager\n- EsLint / StyleLint for linting and code formatting\n\n##  Environment variables\n\nDuplicate the `.env.sample` file and rename it to `.env`.  \nFill in the environment variables with the correct values.\n\n## Setup\n\nMake sure to install the dependencies:\n\n```bash\npnpm install\n```\n\n## Development Server\n\nStart the development server on `http://localhost:3000`:\n\n```bash\npnpm dev\n```\nStart the development server on `http://localhost:6006` with stories preset (use the `.env.stories` file):\n\n```bash\ndocker compose up -d // start the Intervention Request service\npnpm dev:stories\n```\n\n## Production\n\nBuild the application for production:\n\n```bash\npnpm build\n```\n\nLocally preview production build:\n\n```bash\npnpm preview\n```\n\n## Code quality and formatting\n\nRun the following command to lint and format the code:\n\n```bash\npnpm lint\n```\n\n### Lint and format script (JS / Vue files)\n\n```bash\npnpm lint:js\n```\n\n### Lint and format style (CSS / SCSS / Vue files)\n\n```bash\npnpm lint:css\n```\n\n### Lint fix (script and style)\n\n```bash\npnpm lint-fix\n```\n\n## I18n\n\nThe application uses `nuxt-i18n` module for internationalization.  \nPlease refer to the [documentation](https://v8.i18n.nuxtjs.org/) for more information.\n\nThe localized messages come from Xilofone, our translation management system.  \nThe messages can be fetched automatically using the `@rezo-zero/xilofone-fetch` script.  \nFill the Xilofone env variables in the `.env` file.\n\n```dotenv\nXILOFONE_BASE_URL=https://xilofone.rezo-zero.com\nXILOFONE_USERNAME=\nXILOFONE_PASSWORD=\nXILOFONE_FILE_ID=\nXILOFONE_OUTPUT=assets/locales/\n```\n\nRun the following command to fetch the messages:\n```bash\npnpm xilo\n```\n\n## Image\n\nThe application uses `@nuxt/image` module.  \nPlease refer to the Nuxt image module [documentation](https://image.nuxt.com/) for more information.\n\nThe provider by default is Intervention Request.  \nFill the .env file with the values for the provider.\n```dotenv\nNUXT_PUBLIC_INTERVENTION_REQUEST_BASE_URL=\nNUXT_PUBLIC_INTERVENTION_REQUEST_NO_PROCESS_BASE_URL=\nNUXT_PUBLIC_INTERVENTION_REQUEST_IMAGES_PATH=\n```\nSee the provider [documentation](https://github.com/rezozero/intervention-request-provider) for more information.\n\n## SVG\n\n### Single file\n\nUse `vite-svg-loader` to import SVG file.  \nSee the plugin [documentation](https://github.com/jpkleemans/vite-svg-loader) for more information.\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nimport IconCheck from '~/assets/images/icons/check.svg?component'\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n    \u003cdiv\u003e\n        \u003cIconCheck /\u003e\n    \u003c/div\u003e\n\u003c/template\u003e\n```\n\n### Icon module\n\nAll the SVG files in `~/assets/images/icons` can be displayed using the VIcon component.\nSet the file name to display svg as a background-image or mask-image element.\nSee the module `@nuxt/icon` [documentation](https://nuxt.com/modules/icon) for more information.\n\n```vue\n\u003ctemplate\u003e\n    \u003cdiv\u003e\n        \u003cVIcon name=\"check\" /\u003e\n    \u003c/div\u003e\n\u003c/template\u003e\n```\n\n\n## Stories\n\nThe application uses `@rezo-zero/nuxt-stories` module.  \n\nAll the files with the `.stories.vue` extension are automatically imported and displayed in the stories.   \nThe stories are available on `/_stories`.\n\nThe app must use a layout (at least a default one) for allowing the stories to be displayed.  \nSee Nuxt stories [caveat section](https://github.com/rezozero/nuxt-stories?tab=readme-ov-file#caveats).\n\nCheckout the Nuxt stories [documentation](https://github.com/rezozero/nuxt-stories) for more information.\n\n\n## Monitoring\n\nSentry is included in the application for error monitoring.\n\nFill the .env file with the values for enabling Sentry.\n```dotenv\nSENTRY_DSN=\n```\n\n\n## Sitemap\n\nThe application uses `@nuxtjs/sitemap` module.  \nIt generates a sitemap from the `pages/` directory.\nDynamic routes can be added with the server route `/api/sitemap`.\n\nRead the full module documentation [here](https://www.nuxtseo.com/sitemap/getting-started/installation).\n\n## Docker build\n\nThe application can be built and run in a Docker container. This starter provide a multi-stage Dockerfile\nwith a production build and a Nginx server.\n\nYou can test build node image with the following command:\n\n```bash\ndocker buildx build --target node-prod -t nuxt-starter/node .\n```\n\nOr use docker buildx bake to build all images in parallel. Update `docker-bake.hcl` file with your own values.\n\n```bash\ndocker buildx bake\n```\n\nThis starter provide a .gitlab-ci.yml example file for a CI/CD pipeline using docker build.\n\n## Contributing\n\nPlease refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frezozero%2Fnuxt-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frezozero%2Fnuxt-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frezozero%2Fnuxt-starter/lists"}