README.md

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

Getting Started

First, run the development server:

yarn dev

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

Creating Components

yarn new-component [FOLDER_NAME] [COMPONENT_NAME]
# yarn new-component components ComponentName
# yarn new-component ui-kit ComponentName

Directory Structure

• __tests__ — Top-level smoke test for rendering the <App>.
• components — App components that are more specific than ui-kit components.
• config — Configuration files for things like the theme, metadata, etc.
• hooks — Custom Hooks for wrapping useQuery, useMutation, etc.
• lib — Library code.
• pages — The directory structure that dictates the routes and main screens.
• providers — Components that provide data (state or GraphQL) to components.
• public — Public assets.
• scripts — Handy scripts.
• ui-kit — Abstracted ui-kit components and library.
• utils — Utility functions.

Learn More

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

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

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

🍕