Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nileshpatel17/next-typescript-app
next starter with typescript
https://github.com/nileshpatel17/next-typescript-app
Last synced: about 1 month ago
JSON representation
next starter with typescript
- Host: GitHub
- URL: https://github.com/nileshpatel17/next-typescript-app
- Owner: NileshPatel17
- Created: 2020-01-01T14:18:18.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T07:09:50.000Z (about 2 years ago)
- Last Synced: 2023-04-10T17:27:18.532Z (almost 2 years ago)
- Language: TypeScript
- Size: 1010 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TypeScript Next.js example
This is a really simple project that show the usage of Next.js with TypeScript.
## Deploy your own
Deploy the example using [ZEIT Now](https://zeit.co/now):
[](https://zeit.co/new/project?template=https://github.com/zeit/next.js/tree/canary/examples/with-typescript)
## How to use it?
### Using `create-next-app`
Execute [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
```bash
npx create-next-app --example with-typescript with-typescript-app
# or
yarn create next-app --example with-typescript with-typescript-app
```
### Download manually
Download the example:
```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-typescript
cd with-typescript
```
Install it and run:
```bash
npm install
npm run dev
# or
yarn
yarn dev
```
Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download)):
```bash
now
```
## The idea behind the example
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 declaratons 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.