Skip to content

Commit

Permalink
Update readme & keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
danangekal committed Mar 7, 2021
1 parent b34990d commit 3dbdd46
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 19 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,39 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next
## Demo
You can check [demo](https://next-typescript-pwa-starter.vercel.app/)

## Features

- [React.js 17](https://reactjs.org/blog/2020/10/20/react-v17.html) - Blog introduce react v17.0.
- [Next.js 10](https://nextjs.org/blog/next-10) - Blog introduce next.js 10.
- [Typescript 4](https://www.typescriptlang.org/) - Documentation of typescript.
- [Next PWA 5](https://www.npmjs.com/package/next-pwa) - Documentation of next pwa.
- [Docker](https://docs.docker.com/) - Documentation of docker.
- [Eslint 7](https://eslint.org/docs/user-guide/getting-started) - Documentation of eslint.
- [Prettier 2](https://prettier.io/docs/en/index.html) - Documentation of prettier.
- [Husky 5](https://typicode.github.io/husky/#/) - Documentation of husky.
- [Lint Staged 10](https://github.com/okonet/lint-staged) - Documentation of lint staged.

## Usage
This project using node >= 10 & yarn

### Installation

```bash
git clone https://github.com/danangekal/next-typescript-pwa-starter.git
npm install or yarn install
yarn install
```

#### Development

```bash
npm run dev or yarn dev
yarn dev
```

#### Production

```bash
npm run build or yarn build
npm start or yarn start
yarn build
yarn start
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
Expand Down Expand Up @@ -55,18 +68,6 @@ You can use images available on docker hub [next-typescript-pwa-starter](https:/
docker pull danangekal/next-typescript-pwa-starter
```

## Features

- [React.js 17](https://reactjs.org/blog/2020/10/20/react-v17.html) - Blog introduce React v17.0.
- [Next.js 10](https://nextjs.org/blog/next-10) - Blog introduce Next.js 10.
- [Typescript 4](https://www.typescriptlang.org/) - Documentation of Typescript.
- [Eslint 7](https://eslint.org/docs/user-guide/getting-started) - Documentation of Eslint.
- [Prettier 2](https://prettier.io/docs/en/index.html) - Documentation of Prettier.
- [Husky 5](https://typicode.github.io/husky/#/) - Documentation of Husky.
- [Lint Staged 10](https://github.com/okonet/lint-staged) - Documentation of Lint Staged.
- [Next PWA 5](https://www.npmjs.com/package/next-pwa) - Documentation of Next PWA.
- [Docker](https://docs.docker.com/) - Documentation of Docker.

## Learn More

To learn more about Next.js, take a look at the following resources:
Expand Down
4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@
"license": "MIT",
"keywords": [
"nextjs",
"nextjs-starter",
"nextjs-typescript",
"pwa",
"reactjs",
"typescript",
"pwa",
"eslint",
"husky",
"prettier",
Expand Down

1 comment on commit 3dbdd46

@vercel
Copy link

@vercel vercel bot commented on 3dbdd46 Mar 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.