This is a simple starter kit built using the AG Design System, NextJS and Typescript. It is a Next.js project bootstrapped with create-next-app
.
For more information about the AG Design System, please see the documentation website.
For examples of common user interfaces, please see the example site.
First, run the development server:
npm run dev
# or
yarn dev
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx
. The page auto-updates as you edit the file.
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.
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.
- Next.js GitHub repository
Storybook is installed in this starter kit. It helps you build UI components in isolation from your app's business logic, data, and context. That makes it easy to develop hard-to-reach states. Save these UI states as stories to revisit during development, testing, or QA.
Run yarn storybook
and it will open in your default browser. Browse example stories now by navigating to them in the sidebar.
Learn how stories work by browsing the *.stories.tsx
files in the components directory of this repo.
We recommend building UIs with a component-driven process starting with atomic components and ending with pages.