React Web Application Template

This is a template for building web applications with React. It includes a basic project structure and configuration files to help you get started quickly.

Demo

To check out a demo of the latest main branch click here.

Features

This template includes the following features:

• React for building user interfaces.
• TypeScript for static type checking.
• Vite for fast development and building.
• Turborepo for performant build system.
• Tailwind CSS for utility-first CSS.
• DiasyUI for component styling.
• Storybook for component development.
• Storybook Component Test for testing components.
• Playwright for end-to-end testing.
• Vitest for testing components.
• Github Actions for continuous integration.
• Github Pages for hosting the application.
• Prettier for code formatting.
• ESLint for linting.

Getting Started

To get started with this template, follow these steps:

1. Clone the repository to your local machine.
2. Enable corepack by running corepack enable.
3. Install the dependencies by running pnpm i in the project directory.
4. Start the development server by running pnpm dev.

Enable Github Actions

To enable Github Actions for this repository, follow these steps:

1. Go to the Settings tab in the repository.
2. Click the Actions tab in the sidebar.
3. Enable the Allow all actions option.
4. Click the Rules tab in the sidebar.
5. Add a new rule with the following settings:
   • Name: Main
   • Enforcement status: Active
   • Target branches: Include default branch
   • Rules: Require status checks to pass and add Lint, Build, Test Components and Test E2E checks.

Enable Github Pages

To enable Github Pages for this repository, follow these steps:

1. Go to the Settings tab in the repository.
2. Click the Pages tab in the sidebar.
3. Select the deploy/main branch as the source.
4. Update Readme with the correct link to the deployed application.

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue on the GitHub repository. If you would like to contribute code, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.