Install dependencies with pnpm:
pnpm installThen, you can run locally in development mode with live reload:
pnpm devOpen http://localhost:3000 with your favorite browser to see your project.
.
├── README.md # README file
├── next.config.js # Next JS configuration
├── public # Public folder
│ └── img # Images used by the app
├── types # Shared TypeScript interfaces
├── api # Generated API interfaces from Swagger
├── components # Shared components
│ └── X
│ └── X.tsx
│ └── index.ts
│ └── X.stories.tsx
│ └── X.test.tsx
│── pages # Next JS pages
├── context # Shared context state
├── constants # Shared constants
├── hooks # Shared hooks
│ └── tests
│── styles # PostCSS style folder with Tailwind
│ └── vendor # Third-party CSS
│── utils # Utility folder
│ └── tests
│── cypress # Cypress configuration and tests
├── tailwind.config.js # Tailwind CSS configuration
├── tsconfig.json # TypeScript configuration
The project integrates Storybook to streamline UI development.
pnpm storybookThe UI document then should be live at http://localhost:6006.
If your team use Swagger to document APIs, we support a node script to generate TypeScript interfaces via your Swagger scheme. In package.json, change the default path to the location of your Swagger JSON doc.
- "fetch-definitions": "swagger-typescript-api --no-client -p ./libs/swagger.json -o ./types -n schema.ts",
+ "fetch-definitions": "swagger-typescript-api --no-client -p your-api-swagger-json -o ./types -n schema.ts",
Then, you can run the script locally to generate TypeScript definitions for the
APIs:
```bash
pnpm fetch-definitions
The generated interfaces will be located at types/schema.ts.