Skip to content

Commit 6f77df0

Browse files
Add README
1 parent 5756ef2 commit 6f77df0

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
1-
![test and build](https://github.com/KushibikiMashu/nextjs-starter/workflows/test%20and%20build/badge.svg)
1+
# Next.js Starter Kit
2+
![test and build](https://github.com/KushibikiMashu/nextjs-starter-kit/workflows/test%20and%20build/badge.svg)
23

3-
# nextjs-starter
4+
Next.js starter kit is a set of popular libraries for Next.js developers. Next.js starter kit saves your time to set up a new project. This kit is certainly production ready 🚀
5+
6+
Next.js starter kit contains main library with minimum config files below:
7+
8+
- Next.js
9+
- TypeScript
10+
- ESLint
11+
- Tailwind CSS
12+
- Jest
13+
- React Testing Library
14+
- Storybook
15+
16+
# Installation
17+
Clone a copy of the repo:
18+
19+
```sh
20+
$ git clone https://github.com/KushibikiMashu/nextjs-starter-kit.git
21+
```
22+
23+
Change directory to the root:
24+
25+
```sh
26+
$ cd nextjs-starter-kit
27+
```
28+
29+
Install dependencies:
30+
31+
```sh
32+
$ npm ci
33+
```
34+
35+
Run development server:
36+
37+
```sh
38+
$ npm run dev
39+
```
40+
41+
Access [http://localhost:3000](http://localhost:3000) and you'll see `Hello, Next.js Starter Kit`.

0 commit comments

Comments
 (0)