Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Commit

Permalink
🐛 📚 add release to package.json. Add storybook docs to readme
Browse files Browse the repository at this point in the history
add release to package.json. Add storybook docs to readme

🐛 Bugfix, 📚 Documentation
  • Loading branch information
TimMikeladze committed Dec 29, 2022
1 parent 69589f2 commit 6afccd0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Spend more time __building__ instead of _configuring_ your next project.

## 🚪 Intro

This is a slightly opinionated starter kit for developing [Next.js](https://nextjs.org/) apps. It uses the [Joy UI](https://mui.com/joy-ui/getting-started/overview/) library from [MUI](https://mui.com/) along with the [Apollo](https://www.apollographql.com/) stack. All [GraphQL](https://graphql.org/) are operations are fully typed with [GraphQL Codegen](https://the-guild.dev/graphql/codegen) and [Zeus](https://github.com/graphql-editor/graphql-zeus). The starter kit also includes a fully functional [authentication](https://next-auth.js.org/) system, [localization](https://www.i18next.com/), and outputs a [progressive web app](https://github.com/shadowwalker/next-pwa), plus plenty of other goodies for a great developer experience right out of the box.
This is a slightly opinionated starter kit for developing [Next.js](https://nextjs.org/) apps. It uses the [Joy UI](https://mui.com/joy-ui/getting-started/overview/) library from [MUI](https://mui.com/) along with the [Apollao](https://www.apollographql.com/) stack. All [GraphQL](https://graphql.org/) are operations are fully typed with [GraphQL Codegen](https://the-guild.dev/graphql/codegen) and [Zeus](https://github.com/graphql-editor/graphql-zeus). The starter kit also includes a fully functional [authentication](https://next-auth.js.org/) system, [localization](https://www.i18next.com/), and outputs a [progressive web app](https://github.com/shadowwalker/next-pwa), plus plenty of other goodies for a great developer experience right out of the box.

> 👋 Hello there! Follow me [@linesofcodedev](https://twitter.com/linesofcodedev) or visit [linesofcode.dev](https://linesofcode.dev) for more cool projects like this one.
Expand Down Expand Up @@ -71,6 +71,12 @@ Start the Next.js development server and watch GraphQL files for code generation
yarn dev
```

Working on the UI? Start Storybook to develop components in isolation.

```console
yarn storybook
```

### 🔬 Testing

Run tests when changes are detected.
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"lint": "eslint --ignore-path .eslintignore \"src/**/*.+(ts|js|tsx)\"",
"format": "prettier --ignore-path .eslintignore \"src/**/*.+(ts|js|tsx)\" --write",
"postinstall": "husky install",
"release": "release-it",
"commit": "commit-it",
"storybook": "start-storybook -p 6006",
"build-storybook": "build-storybook",
Expand Down

1 comment on commit 6afccd0

@vercel
Copy link

@vercel vercel bot commented on 6afccd0 Dec 29, 2022

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.