Skip to content

Latest commit

 

History

History
72 lines (41 loc) · 2.48 KB

README.md

File metadata and controls

72 lines (41 loc) · 2.48 KB

camp6-final-project

This is a Next.js project bootstrapped with create-next-app.

This project uses the yarn package manager.

Getting Started

First, install all dependencies:

yarn install

Then, either start Storybook to work on the components:

yarn storybook

Open http://localhost:6006 with your browser to see the result.

Or run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Unit Testing with Vitest

We use Vitest to test our code. It is already set up, just make sure to yarn install and create a test file.

Test files should be placed in the same folder as the code you wish to test. The file be named spec.ts. For an example, check out pages/api/book/spec.ts.

For details and examples check the documentation linked below.

Open your terminal and use the following script to run Jest:

yarn test

Check out the guide for details.

Learn More

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

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Storybook

Installed the ESLint Plugin for Storybook https://github.com/storybookjs/eslint-plugin-storybook#readme

For details and info on Storybook check the introduction file inside the stories folder.