- Fork this repo in repo with the name you want as url prefix. E.g. meetup-template will be become https://code-star.github.io/meetup-template.
- Enable Pages hosting under Settings > Pages. Set source to gh-pages.
- Modify text and links in public/locales/nl/common.json
- Update basePath in next.config.js
- Test locally (see commands below)
- On push to Github, build will be done automatically with Github Actions
Not needed?
- (Not needed?) Add an Access token under Settings > Secrets > Actions
Commands:
- develop:
npm run dev
(open http://localhost:3000/meetup-template) - build:
npm run build
&serve out/
(will host on http://localhost:3000, but basePath won't be resolved so assets are not loaded)
- Static building with i18n
- Ordina favicon
- Styling
- Is URL shape acceptable?
This is a really simple project that shows the usage of Next.js with TypeScript.
Deploy the example using Vercel or preview live with StackBlitz
Execute create-next-app
with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example with-typescript with-typescript-app
# or
yarn create next-app --example with-typescript with-typescript-app
# or
pnpm create next-app --example with-typescript with-typescript-app
Deploy it to the cloud with Vercel (Documentation).
This example shows how to integrate the TypeScript type system into Next.js. Since TypeScript is supported out of the box with Next.js, all we have to do is to install TypeScript.
npm install --save-dev typescript
To enable TypeScript's features, we install the type declarations for React and Node.
npm install --save-dev @types/react @types/react-dom @types/node
When we run next dev
the next time, Next.js will start looking for any .ts
or .tsx
files in our project and builds it. It even automatically creates a tsconfig.json
file for our project with the recommended settings.
Next.js has built-in TypeScript declarations, so we'll get autocompletion for Next.js' modules straight away.
A type-check
script is also added to package.json
, which runs TypeScript's tsc
CLI in noEmit
mode to run type-checking separately. You can then include this, for example, in your test
scripts.