Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gitnlsn committed Aug 6, 2023
1 parent ab1d5ad commit e4bc1cc
Show file tree
Hide file tree
Showing 4 changed files with 1,535 additions and 1,419 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Docs: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs

name: Build

on:
push:
branches: ["master", "develop"]
pull_request:
branches: ["master", "develop"]

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [16.x, 18.x]
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
- run: yarn
- run: npx next build
43 changes: 18 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,27 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started

First, run the development server:
# Preparing environment

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# Install dependencies
yarn
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.

## Learn More

To learn more about Next.js, take a look at the following resources:
# Building

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
```bash
# Build with next tool
npx next build
```

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
# Running application

## Deploy on Vercel
```bash
# Run with next tool
npx next dev
```

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
# Storybook

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
```bash
# Run storybook
npx storybook dev -p 6000
```
18 changes: 9 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,18 @@
"zod": "^3.21.4"
},
"devDependencies": {
"@storybook/addon-essentials": "^7.0.27",
"@storybook/addon-interactions": "^7.0.27",
"@storybook/addon-links": "^7.0.27",
"@storybook/blocks": "^7.0.27",
"@storybook/nextjs": "^7.0.27",
"@storybook/react": "^7.0.27",
"@storybook/testing-library": "^0.0.14-next.2",
"@storybook/addon-essentials": "^7.2.1",
"@storybook/addon-interactions": "^7.2.1",
"@storybook/addon-links": "^7.2.1",
"@storybook/blocks": "^7.2.1",
"@storybook/nextjs": "^7.2.1",
"@storybook/react": "^7.2.1",
"@storybook/testing-library": "^0.2.0",
"@types/node": "20.4.2",
"@types/react": "18.2.15",
"@types/react-dom": "18.2.7",
"@types/react-input-mask": "^3.0.2",
"eslint-plugin-storybook": "^0.6.12",
"storybook": "^7.0.27"
"eslint-plugin-storybook": "^0.6.13",
"storybook": "^7.2.1"
}
}
Loading

0 comments on commit e4bc1cc

Please sign in to comment.