https://github.com/permafrost-dev/nextjs-site-template
Basic Next.js template with Typescript, ESLint, Prettier, Tailwind CSS & more
https://github.com/permafrost-dev/nextjs-site-template
eslint nextjs prettier template template-repository typescript
Last synced: 3 months ago
JSON representation
Basic Next.js template with Typescript, ESLint, Prettier, Tailwind CSS & more
- Host: GitHub
- URL: https://github.com/permafrost-dev/nextjs-site-template
- Owner: permafrost-dev
- License: mit
- Created: 2022-08-07T03:34:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T00:15:30.000Z (about 2 years ago)
- Last Synced: 2024-05-01T11:30:37.965Z (about 2 years ago)
- Topics: eslint, nextjs, prettier, template, template-repository, typescript
- Language: JavaScript
- Homepage:
- Size: 1.74 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Next.js Basic Website Template
## Project Configuration
After creating a project from the template repository, run the following to configure the project:
```bash
node configure-project.js
```
This will configure optional features, update template variable placeholders, install all dependencies and commit all changes to git. **This should be your first step after creating the repository**
## Getting Started
Run the development server:
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
The `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.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!