1. Project Overview & Quickstart (Avaiga/taipy) Copy Chapter

Build Python Data & AI web applications

Table of Contents Copy Chapter

• Taipy? What for?
• Taipy and its ecosystem
• Quickstart
• Documentation and resources
• Contributing
• Code of Conduct
• License

⭐ What for? Copy Chapter

Taipy is designed for data scientists and machine learning engineers to create
data & AI driven web applications.

⭐️ Enables building production-ready web applications.
⭐️ No need to learn new languages; only Python is needed.
⭐️ Focus on data and AI algorithms. Delegates development complexities to Taipy.
⭐️ Simplifies production operations (hosting, deployments, maintenance, etc.).

✨ Taipy and Taipy Ecosystem Copy Chapter

Taipy includes the Taipy Python library enabling developers to easily empower their end-users with:

• User interface generation
• Data Integration
• Pipeline orchestration
• What-if analysis and scenario management
• Authentication, roles and user management
• Cron jobs and scheduling

Besides the Taipy Library, the Taipy Ecosystem includes:

• Taipy Designer
• Taipy Studio
• Predefined templates
• Data platform integration

Taipy comes with a set of materials to facilitate production operations and maintenance.

• Command line interface.
• Deployment scripts.
• Version Management.
• Data migration.
• Telemetry and monitoring.

⏩ Quickstart Copy Chapter

To install the stable release of Taipy, run:

pip install taipy

For alternative installation methods, an
Installation Guide
provides step-by-step instructions.

💡 Documentation and resources Copy Chapter

A comprehensive documentation set is available at
Taipy Documentation to help you with Taipy tools.

It includes
Tutorials,
user manuals,
API references, and
Galleries.

⚒️ Contributing Copy Chapter

Want to help build Taipy? Check out our Contributing Guide.

🪄 Code of Conduct Copy Chapter

Want to be part of the Taipy community? Check out our Code of Conduct

🪪 License Copy Chapter

Copyright 2021-2025 Avaiga Private Limited

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
Apache License

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.

2. Official Technical Reference & Guides (Avaiga/website) Copy Chapter

Next.js TypeScript Tailwind Starter

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

Table of Contents Copy Chapter

• Getting Started
• Usage
  • Learn more
  • Build the website
• Project Structure
• Code Style
  • ESLint
  • Prettier
  • VS Code

Getting Started Copy Chapter

1. Clone this repository or hit "Use this template" button

   bash Copy

   git clone [email protected]:pixel-point/nextjs-typescript-tailwind-starter.git

2. Install dependencies

npm install

Usage Copy Chapter

npm run dev

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

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Learn More Copy Section

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!

Deploy on Vercel Copy Section

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.

Project Structure Copy Chapter

├── public
├── src
│   ├── components
│   │  ├── pages — React components that are being used specifically on a certain page
│   │  └── shared — React components that are being used across the whole website
│   ├── app
│   ├── svgs — a folder for vector images
│   ├── images — a folder for bitmap images
│   ├── lib
│   ├── types
├── next.config.js — Main configuration file for a Next.js site. Read more about it [here](https://nextjs.org/docs/api-reference/next.config.js/introduction)
└── tailwind.config.js — Main configuration file for Tailwind CSS [Read more about it here](https://tailwindcss.com/docs/configuration)

Component Folder Structure Copy Chapter

Each component includes Copy Section

1. Main TypeScript File
2. Index File

Each component optionally may include Copy Section

1. Folder with images and icons
2. Folder with data

Also, each component may include another component that follows all above listed rules.

Example structure Copy Section

component
├── nested-component
│  ├── data
│  │  └── nested-component-lottie-data.json
│  ├── images
│  │  ├── nested-component-image.jpg
│  │  ├── nested-component-inline-svg.inline.svg
│  │  └── nested-component-url-svg.url.svg
│  ├── nested-component.tsx
│  └── index.ts
├── data
│  └── component-lottie-data.json
├── images
│  ├── component-image.jpg
│  ├── component-inline-svg.inline.svg
│  └── component-url-svg.url.svg
├── component.tsx
└── index.ts

Code Style Copy Chapter

ESLint Copy Section

ESLint helps find and fix code style issues and force developers to follow same rules. Current configuration is based on eslint:recommended, next/core-web-vitals and @typescript-eslint/recommended rules sets.

Additional commands:

npm run lint

Run it to check the current status of eslint issues across project.

npm run lint:fix

Run it to fix all possible issues.

Prettier Copy Section

Prettier helps to format code based on defined rules. Difference between Prettier and ESLint.

Additional commands:

npm run format

Run it to format all files across the project.

VS Code Copy Section

Following extensions required to simplify the process of keeping the same code style across the project:

• ESLint
• Prettier

After installation, VS Code will be use settings from the .vscode/settings.json file and will be fixing and formatting your code automatically on paste and save actions.