Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/riipandi/blueprint-turborepo

Bare minimum monorepo project template built on Turborepo.
https://github.com/riipandi/blueprint-turborepo

monorepo react storybook tailwind-merge tailwind-variants tailwindcss turborepo vite

Last synced: about 1 month ago
JSON representation

Bare minimum monorepo project template built on Turborepo.

Awesome Lists containing this project

README

        

# 🚀 Turborepo Blueprint

[![License MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE-MIT)
[![License Apache](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE-APACHE)
[![Turborepo](https://img.shields.io/badge/Built%20With-Turborepo-blueviolet)][turborepo]
[![Contribution](https://img.shields.io/badge/Contributions-welcome-gray.svg)][contribution]

Minimal monorepo starter with Turborepo, Vite, Tailwind CSS, and TypeScript.

## Quick Start

Run the following command:

```sh
npx tiged riipandi/blueprint-turborepo my-new-project
```

## What's inside?

This Turborepo includes the following packages and apps:

### Apps and Packages

- `docs`: Documentation site built with [Vite][vite] and [Storybook][storybook]
- `web`: Example main web application built with [Vite][vite] and [React][reactjs]
- `@repo/config-typescript`: Shared TypeScript configurations
- `@repo/ui-react`: Reusable React components and utilities

Each package and app is 100% [TypeScript][typescript].

### Utilities

This Turborepo has some additional tools already setup for you:

- [TypeScript][typescript] for static type checking
- [Biome][biome] for code formatting and linting

## Tasks to Complete

After creating a new project from this template repository, ensure you update the documentation, including:

1. **Project Overview:** Briefly describe the project's purpose and features.
2. **Installation Instructions:** Update steps to reflect any project-specific changes.
3. **Usage Guide:** Provide instructions on how to use the project, including commands and configurations.
4. **API Documentation:** If applicable, update API endpoints, request/response formats, and examples.
5. **Contributing Guidelines:** Reflect any new processes or requirements for contributions.
6. **License Information:** Ensure the license is accurate for the new project.

Keeping documentation current helps others understand, use, and contribute to the project.

## License

Licensed under either of [Apache License 2.0][license-apache] or [MIT license][license-mit] at your option.

> Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you,
> as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Copyrights in this project are retained by their contributors.

See the [LICENSE-APACHE](./LICENSE-APACHE) and [LICENSE-MIT](./LICENSE-MIT) files for more information.

---

🤫 Psst! If you like my work you can support me via [GitHub sponsors](https://github.com/sponsors/riipandi).

[biome]: https://biomejs.dev
[contribution]: https://github.com/riipandi/blueprint-turborepo/pulse
[license-apache]: https://choosealicense.com/licenses/apache-2.0/
[license-mit]: https://choosealicense.com/licenses/mit/
[reactjs]: https://react.dev
[storybook]: https://storybook.js.org
[tailwind]: https://tailwindcss.com
[turborepo]: https://turbo.build/repo/docs
[typescript]: https://www.typescriptlang.org/
[vite]: https://vite.dev