https://github.com/pixelass/capstone-project-test
https://github.com/pixelass/capstone-project-test
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/pixelass/capstone-project-test
- Owner: pixelass
- License: mit
- Created: 2022-09-13T07:41:47.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-13T07:41:49.000Z (almost 4 years ago)
- Last Synced: 2025-04-08T17:52:38.765Z (over 1 year ago)
- Language: JavaScript
- Size: 106 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Next.js App
This is a template for [Next.js](https://nextjs.org/) with additional tools.
- [Tech-Stack](#tech-stack)
- [Project Setup](#project-setup)
- [Set up Vercel](#set-up-vercel)
- [App](#app)
- [Storybook](#storybook)
- [Getting started](#getting-started)
- [Test Driven Development](#test-driven-development)
- [Commands](#commands)
It uses the following tools/libraries:
## Tech-Stack
- [Next.js](https://nextjs.org/)
- [Storybook](https://storybook.js.org/)
- [Jest](https://jestjs.io/)
- [Testing Library](https://testing-library.com/)
- [Stylelint](https://stylelint.io/)
- [Eslint](https://eslint.org/)
- [Prettier](https://prettier.io/)
- [Husky](https://typicode.github.io/husky/)
- [Zustand](https://zustand-demo.pmnd.rs/)
## Project Setup
This project uses multiple Vercel deployments to make design/code reviews easier:
- App Production
- App Preview
- Storybook Production
- Storybook Preview
### Set up Vercel
Please follow this guide: https://vercel.com/docs/concepts/git
#### App
1.Follow the default setup for Next.js.
#### Storybook
1. Adjust the "Build and Output Settings"
- BUILD COMMAND: `npm run storybook:build`
- OUTPUT DIRECTORY: `./storybook-static`
## Getting started
**Run the development server:**
```bash
npm run dev
```
**Run storybook:**
```shell
npm run storybook
```
## Test Driven Development
We use jest to write unit tests. Please look at the Documentation for [Jest](https://jestjs.io/)
and [testing-library](https://testing-library.com/docs/react-testing-library/intro/).
## Commands
**Run the development server:**
```bash
npm run dev
```
**Build:**
```shell
npm run build
```
**Run storybook:**
```shell
npm run storybook
```
**Build storybook:**
```shell
npm run storybook:build
```
**Run all tests:**
```shell
npm run test
```
**Run stylelint**
```shell
npm run stylelint
```
**Run eslint**
```shell
npm run eslint
```
**Run all linters**
```shell
npm run lint
```