{"id":28141355,"url":"https://github.com/experience-monks/nextjs-boilerplate","last_synced_at":"2025-05-14T18:15:14.973Z","repository":{"id":37930848,"uuid":"237316455","full_name":"Experience-Monks/nextjs-boilerplate","owner":"Experience-Monks","description":"Jam3 NextJS Generator for SPA, SSG, SSR and JAMStack applications","archived":false,"fork":false,"pushed_at":"2024-10-29T20:35:22.000Z","size":31293,"stargazers_count":110,"open_issues_count":20,"forks_count":18,"subscribers_count":31,"default_branch":"main","last_synced_at":"2025-03-30T09:01:57.596Z","etag":null,"topics":["backend","boilerplate","frontend","generator","nextjs","nyg","react","ssr","static"],"latest_commit_sha":null,"homepage":"https://generator.jam3.net/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Experience-Monks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2020-01-30T22:16:08.000Z","updated_at":"2025-02-23T05:09:27.000Z","dependencies_parsed_at":"2023-02-08T05:16:45.544Z","dependency_job_id":"f4a7d51e-3a34-45e1-abcb-2f7edf2705cb","html_url":"https://github.com/Experience-Monks/nextjs-boilerplate","commit_stats":null,"previous_names":["experience-monks/nextjs-boilerplate","jam3/nextjs-boilerplate"],"tags_count":14,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Experience-Monks%2Fnextjs-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Experience-Monks%2Fnextjs-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Experience-Monks%2Fnextjs-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Experience-Monks%2Fnextjs-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Experience-Monks","download_url":"https://codeload.github.com/Experience-Monks/nextjs-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254198433,"owners_count":22030966,"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","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":["backend","boilerplate","frontend","generator","nextjs","nyg","react","ssr","static"],"created_at":"2025-05-14T18:13:00.358Z","updated_at":"2025-05-14T18:15:14.966Z","avatar_url":"https://github.com/Experience-Monks.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Welcome to Monks NextJS Generator! 🚀\n\nHey there, developer! Ready to dive into our awesome NextJS Boilerplate? This guide will help you set up and start developing in no time. Let's get started!\n\n## Table of Contents\n\n- [Setting Up](#setting-up)\n- [Development](#development)\n- [Documentation](#documentation)\n- [License](#license)\n\n## Setting Up\n\n### 1. Check Your Node and NPM Versions\n\nFirst things first, let's make sure you're using the right versions:\n\n- Node: 18.19.0\n- NPM: 10.2.3\n\nPro tip: Use NVM to manage your Node versions easily!\n\n```bash\nnvm install 18.19.0\nnvm use 18.19.0\n```\n\n### 2. Install git-lfs\n\nWe use Git LFS for managing large files. Here's how to set it up:\n\n- **For Ubuntu/Debian fans:**\n\n  ```bash\n  curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash\n  sudo apt-get install git-lfs\n  ```\n\n- **Mac users (with Homebrew):**\n\n  ```bash\n  brew update\n  brew install git-lfs\n  ```\n\n- **Windows users:** Grab the installer from [Git LFS Releases](https://github.com/git-lfs/git-lfs/releases)\n\n### 3. Set Up Your GSAP Token\n\nTo install our npm packages, you'll need a GSAP token. Ask your project lead for this key!\n\n- **For Mac/Linux:**\n  Add to your shell profile (e.g., `~/.bash_profile`, `~/.zshrc`):\n\n  ```bash\n  export GSAP_NPM_TOKEN=\u003cyour-gsap-token\u003e\n  ```\n\n- **For Windows:**\n  Choose your favorite method:\n  1. Command Prompt:\n     ```\n     setx GSAP_NPM_TOKEN \"\u003cyour-gsap-token\u003e\"\n     ```\n  2. PowerShell:\n     ```powershell\n     [Environment]::SetEnvironmentVariable(\"GSAP_NPM_TOKEN\", \"\u003cyour-gsap-token\u003e\", [System.EnvironmentVariableTarget]::User)\n     ```\n  3. GUI: Search for \"Environment Variables\" in the Start menu and add it there.\n\nRemember to restart your terminal after setting this up!\n\n### 4. Set Up Your Linters\n\nFor a smooth coding experience, set up these linters in VSCode:\n\n- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)\n- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)\n- [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)\n\nUpdate your VSCode settings (JSON) with our recommended configuration:\n\n1. Press `Cmd + Shift + P` (on Mac) or `Ctrl + Shift + P` (on Windows/Linux)\n2. Type \"Open Settings (JSON)\" and select it\n3. Add or update the following settings:\n\n```json\n{\n  \"[html]\": {\n    \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n  },\n  \"[scss]\": {\n    \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n  },\n  \"[json]\": {\n    \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n  },\n  \"[javascript]\": {\n    \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n  },\n  \"[typescript]\": {\n    \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n  },\n  \"[typescriptreact]\": {\n    \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n  },\n  \"[jsonc]\": {\n    \"editor.defaultFormatter\": \"esbenp.prettier-vscode\"\n  },\n  \"editor.formatOnSave\": true,\n  \"editor.codeActionsOnSave\": {\n    \"source.fixAll.eslint\": \"explicit\"\n  },\n  \"stylelint.validate\": [\"css\", \"scss\"]\n}\n```\n\nThese settings ensure that:\n\n- Prettier formats your code on save\n- ESLint fixes issues automatically\n- Stylelint validates your CSS and SCSS files\n\nWith these linters set up, you'll catch and fix issues early, keeping your code clean and consistent!\n\n### 5. Clone the Repo\n\n```bash\ngit clone git@github.com:Experience-Monks/nextjs-boilerplate.git\n```\n\n### 6. Install Dependencies\n\n```bash\nnpm install\n```\n\n## Development\n\nReady to code? Start your local server:\n\n```bash\nnpm run dev\n```\n\nThis will fire up:\n\n- Frontend (https): https://localhost:3000\n- Storybook: http://localhost:9001\n\n## Documentation\n\nWant to dive deeper? Check out our docs:\n\n- [File Structure And Organization](./docs/file-structure-and-organization.md)\n- [Template Generator](./docs/template-generator.md)\n- [Copy Management](./docs/copy-management.md)\n- [Import Aliases](./docs/import-aliases.md)\n\n## License\n\nWe're open source! Check out our [MIT License](LICENSE).\n\nHappy coding! 🎉👩‍💻👨‍💻\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexperience-monks%2Fnextjs-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexperience-monks%2Fnextjs-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexperience-monks%2Fnextjs-boilerplate/lists"}