Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/resir014/nextjs-typescript-quickstart

Get started on Next.js with TypeScript in seconds.
https://github.com/resir014/nextjs-typescript-quickstart

nextjs react starter-kit typescript

Last synced: 4 months ago
JSON representation

Get started on Next.js with TypeScript in seconds.

Awesome Lists containing this project

README

        

# nextjs-typescript-quickstart

> Get started on Next.js with TypeScript in seconds.

This is an example setup of Next.js building on top of the [official TypeScript example](https://github.com/zeit/next.js/tree/master/examples/with-typescript). It adds the following:

- Simple styling structure with [CSS Modules](https://github.com/css-modules/css-modules)
- Basic ESLint and Prettier setup
- TypeScript typechecking as part of `test` script (ready to plug into any CI)

## Deploy your own

Deploy the example using [Vercel](https://vercel.com):

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/resir014/nextjs-typescript-quickstart)

## How to use

Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:

```bash
npx create-next-app --example https://github.com/resir014/nextjs-typescript-quickstart nextjs-typescript-quickstart-app
# or
yarn create next-app --example https://github.com/resir014/nextjs-typescript-quickstart nextjs-typescript-quickstart-app
```

Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js) ([Documentation](https://nextjs.org/docs/deployment)).