mirror of
https://github.com/siv-org/siv.git
synced 2026-01-09 10:27:57 -05:00
Remove readme template
This commit is contained in:
40
README.md
40
README.md
@@ -1,48 +1,10 @@
|
||||
# NextJS Typescript Boilerplate
|
||||
|
||||
Bootstrap a developer-friendly NextJS app configured with:
|
||||
|
||||
- [Typescript](https://www.typescriptlang.org/)
|
||||
- Linting with [ESLint](https://eslint.org/)
|
||||
- Formatting with [Prettier](https://prettier.io/)
|
||||
- Linting, typechecking and formatting on by default using [`husky`](https://github.com/typicode/husky) for commit hooks
|
||||
- Testing with [Jest](https://jestjs.io/) and [`react-testing-library`](https://testing-library.com/docs/react-testing-library/intro)
|
||||
|
||||
## Deploy your own
|
||||
|
||||
Deploy the example using [Vercel](https://vercel.com):
|
||||
|
||||
[](https://vercel.com/import/project?template=https://github.com/vercel/next.js/tree/canary/examples/with-typescript-eslint-jest)
|
||||
|
||||
## How to use
|
||||
|
||||
### Using `create-next-app`
|
||||
|
||||
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:
|
||||
Install dependencies and run:
|
||||
|
||||
```bash
|
||||
npx create-next-app --example with-typescript-eslint-jest with-typescript-eslint-jest-app
|
||||
# or
|
||||
yarn create next-app --example with-typescript-eslint-jest with-typescript-eslint-jest-app
|
||||
```
|
||||
|
||||
### Download manually
|
||||
|
||||
Download the example:
|
||||
|
||||
```bash
|
||||
curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-typescript-eslint-jest
|
||||
cd with-typescript-eslint-jest
|
||||
```
|
||||
|
||||
Install it and run:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev
|
||||
# or
|
||||
yarn
|
||||
yarn dev
|
||||
```
|
||||
|
||||
Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|
||||
|
||||
Reference in New Issue
Block a user