{"id":27055085,"url":"https://github.com/rethunk-tech/nextjs-boilerplate","last_synced_at":"2025-04-05T09:18:52.685Z","repository":{"id":37049195,"uuid":"483509670","full_name":"Rethunk-Tech/nextjs-boilerplate","owner":"Rethunk-Tech","description":"Opinionated Next.JS Boilerplate with TypeScript and Material-UI","archived":false,"fork":false,"pushed_at":"2024-08-15T00:50:58.000Z","size":9309,"stargazers_count":13,"open_issues_count":2,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-08-15T01:55:22.869Z","etag":null,"topics":["boilerplate","eslint","material-ui","nextjs","nextjs-boilerplate","react","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Rethunk-Tech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2022-04-20T04:45:04.000Z","updated_at":"2024-08-15T01:55:25.760Z","dependencies_parsed_at":"2024-02-03T19:32:40.017Z","dependency_job_id":"c4ba7cdd-0d66-400b-863c-91ecc683adfd","html_url":"https://github.com/Rethunk-Tech/nextjs-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rethunk-Tech%2Fnextjs-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rethunk-Tech%2Fnextjs-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rethunk-Tech%2Fnextjs-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rethunk-Tech%2Fnextjs-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rethunk-Tech","download_url":"https://codeload.github.com/Rethunk-Tech/nextjs-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312219,"owners_count":20918389,"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":["boilerplate","eslint","material-ui","nextjs","nextjs-boilerplate","react","typescript"],"created_at":"2025-04-05T09:18:52.167Z","updated_at":"2025-04-05T09:18:52.661Z","avatar_url":"https://github.com/Rethunk-Tech.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Next.JS Boilerplate\n\n[![CodeQL Analysis Workflow Status](https://github.com/Rethunk-Tech/nextjs-boilerplate/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Rethunk-Tech/nextjs-boilerplate/actions)\n[![Cypress Workflow Status](https://github.com/Rethunk-Tech/nextjs-boilerplate/actions/workflows/cypress-ubuntu.yml/badge.svg)](https://github.com/Rethunk-Tech/nextjs-boilerplate/actions)\n[![License](https://badgen.net/badge/License/CC-BY-NC-SA-2.0/blue)](https://github.com/Rethunk-Tech/nextjs-boilerplate/blob/main/LICENSE.txt)\n\nThis is an opinionated [Next.js](https://nextjs.org/) boilerplate, with:\n\n- Fully typed with [TypeScript](https://www.typescriptlang.org/).\n- Style/Theme engine and Icons from [Material UI](https://mui.com/).\n- Code style is enforced by React [ESLint](https://eslint.org/) rules.\n- End-to-End Testing with [Cypress](https://www.cypress.io/).\n\n## Getting Started\n\n### First-Time Setup\n\nIf this is your first time using NodeJS, you'll need to install Yarn to use this project:\n\n(You only need to do this once per system you develop on.)\n\n```bash\nnpm install -g yarn\n```\n\nThen, we can clone the repository into a path of your choosing:\n\n```bash\ngit clone https://github.com/Rethunk-Tech/nextjs-boilerplate.git project-name\ncd project-name\n```\n\nFinally, install the dependencies using yarn.\n\n```bash\ncd project-name\nyarn install\n```\n\n### Running the Dev Server\n\nYou can run the server locally with the following command:\n\n```bash\nyarn run dev -p 9000\n```\n\n### With Docker\n\nOr, you can use Docker to run the server within containers:\n\n1. Install [Docker Compose](https://docs.docker.com/compose/install/)\n\n1. Enable [BuildKit for Docker](https://docs.docker.com/develop/develop-images/build_enhancements/#to-enable-buildkit-builds). (It's faster and has cache.)\n\n1. \"Up\" the composition (specifying `--build` to force a re-build):\n\n    ```bash\n    docker-compose up --build\n    ```\n\nOpen [http://localhost:9000](http://localhost:9000) with your browser to see the result.\n\n#### Debugging\n\nIf you need to debug something inside the container, you can get a shell using:\n\n```bash\ndocker-compose run --rm -u 0 nextjs sh\n```\n\n## Developing with this Boilerplate\n\nFirst, open `http://localhost:9000/` in a browser, and open `pages/index.tsx` in your preferred editor. Side-by-side the windows as shown below for the most convenient developing experience! (Even better with more monitors.)\n\nAny changes made to a file in `pages` will automatically update in the browser as long as the dev server is running.\n\nYou can start editing the page by modifying `pages/index.tsx`.\n\n[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:9000/api/hello](http://localhost:9000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.\n\nThe `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.\n\n## Learn More\n\n### TypeScript\n\n- [TypeScript Documentation](https://www.typescriptlang.org/docs/) - learn about TypeScript features.\n- [TypeScript Tutorial](https://www.typescripttutorial.net/) - assumes you know JavaScript already.\n\n### Next.JS\n\n- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.\n- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.\n- [Next.js GitHub Repository](https://github.com/vercel/next.js/)\n\n### Material UI\n\n- [Material UI Components](https://mui.com/material-ui/) - index of Material UI components.\n- [Getting Started with Material UI](https://mui.com/material-ui/getting-started/learn/) - learning resources for Material UI.\n- [Material UI GitHub Repository](https://github.com/mui/material-ui)\n\n### Cypress E2E Testing\n\n- [Cypress: Writing Your First Test](https://docs.cypress.io/guides/getting-started/writing-your-first-test) - Get started with Cypress testing.\n- [Cypress GitHub Repository](https://github.com/cypress-io/cypress)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frethunk-tech%2Fnextjs-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frethunk-tech%2Fnextjs-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frethunk-tech%2Fnextjs-boilerplate/lists"}