Skip to content

Saeed-Altout/Fast-Ui

Repository files navigation

Fast UI

Fast UI is a modern, high-performance web application foundation built with the absolute latest technologies in the React ecosystem. This starter kit is engineered for speed, scalability, and an exceptional developer experience.

🚀 Tech Stack

This project leverages a bleeding-edge stack to provide the best possible performance and developer tooling:

  • Next.js 16: The latest release of the React Framework, featuring advanced routing and server-side capabilities.
  • React 19: Utilizing the newest concurrent features and server actions.
  • Tailwind CSS 4: The next generation of the utility-first CSS framework, faster and more efficient.
  • Shadcn/UI: A collection of re-usable components built using Radix UI and Tailwind CSS.
  • Storybook 8: A frontend environment for building UI components in isolation, ensuring robustness and reusability.
  • Vitest: A blazing fast unit test framework powered by Vite.
  • Playwright: Reliable end-to-end testing for modern web apps.

🛠️ Getting Started

Prerequisites

  • Node.js: v20 or higher is recommended.
  • Package Manager: npm, yarn, pnpm, or bun.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/fast-ui.git
    cd fast-ui
  2. Install dependencies:

    npm install
    # or
    yarn install
    # or
    pnpm install

Development Server

Start the Next.js development server:

npm run dev

Visit http://localhost:3000 to view the application.

📖 Component Development

We use Storybook to document and develop components in isolation. This allows for visual testing and ensures a consistent design system.

To start the Storybook server:

npm run storybook

Visit http://localhost:6006 to browse the component library.

🧪 Testing

Visual Regression Testing

This project is configured with Chromatic for build-based visual testing.

npm run chromatic

End-to-End Testing

Run integration and E2E tests using Playwright:

npx playwright test

Unit Testing

Run unit tests using Vitest:

npx vitest

📁 Project Structure

Here's an overview of the project's organization:

├── app/                  # Next.js App Router (Pages, Layouts, API Routes)
├── components/           # Reusable UI components (including Shadcn/UI)
│   ├── ui/               # Primitive UI components (buttons, inputs, etc.)
│   └── ...
├── lib/                  # Utility functions, shared logic, and configurations
├── stories/              # Storybook stories for components
├── public/               # Static assets (images, fonts, etc.)
├── package.json          # Project dependencies and scripts
└── ...

🤝 Contributing

Contributions make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.


Developed by Your Name

About

Fast UI is a modern, high-performance web application foundation built with the absolute latest technologies in the React ecosystem. This starter kit is engineered for speed, scalability, and an exceptional developer experience.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors