|
| 1 | +# create-typical-env |
| 2 | + |
| 3 | +[](https://www.npmjs.com/package/create-typical-env) |
| 4 | +[](https://opensource.org/licenses/MIT) |
| 5 | +[](https://github.com/typical-developer) |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +### What is create-typical-env |
| 10 | + |
| 11 | +A simple CLI tool that instantly sets up a React + Tailwind + Shadcn project with additional utilities like clsx, tailwind-merge, and AOS — all configured and ready to use. |
| 12 | + |
| 13 | +It eliminates repetitive setup tasks and ensures a consistent, modern development environment every time you start a new project. |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +### Features |
| 18 | + |
| 19 | +| Tool | Description | |
| 20 | +| -------------------- | ------------------------------------------------------------- | |
| 21 | +| **React** | JavaScript library for building user interfaces | |
| 22 | +| **Vite** | Next-generation frontend tooling | |
| 23 | +| **Tailwind CSS** | Utility-first CSS framework | |
| 24 | +| **CLSx** | Utility for constructing conditional className strings | |
| 25 | +| **Tailwind Merge** | Intelligent merge for Tailwind CSS classes | |
| 26 | +| **React Router** | Declarative routing for React | |
| 27 | +| **React Router DOM** | DOM bindings for React Router | |
| 28 | +| **Boxicons** | Icon library | |
| 29 | +| **CSS AOS Library** | Animate On Scroll library | |
| 30 | +| **Shadcn UI** | Reusable, accessible components built with Radix and Tailwind | |
| 31 | +| **React Bits** | Reusable UI/UX React components and hooks | |
| 32 | + |
| 33 | +--- |
| 34 | + |
| 35 | +### Installation |
| 36 | + |
| 37 | +Using `npm` (recommended): |
| 38 | + |
| 39 | +```bash |
| 40 | +npm create typical-env@latest |
| 41 | +``` |
| 42 | + |
| 43 | +or with `npx`: |
| 44 | + |
| 45 | +```bash |
| 46 | +npx create-typical-env |
| 47 | +``` |
| 48 | + |
| 49 | +This will automatically: |
| 50 | + |
| 51 | +1. Clone the preconfigured <a href="https://github.com/typical-developer/Typical-Env">template</a> |
| 52 | +2. Install all dependencies |
| 53 | +3. Set up the environment instantly |
| 54 | + |
| 55 | +Then run your app: |
| 56 | + |
| 57 | +```bash |
| 58 | +cd my-app |
| 59 | +npm run dev |
| 60 | +``` |
| 61 | + |
| 62 | +--- |
| 63 | + |
| 64 | +### NPM Package |
| 65 | + |
| 66 | +You can view or install the CLI directly from npm: |
| 67 | + |
| 68 | +<p align="center"> |
| 69 | + <a href="https://www.npmjs.com/package/create-typical-env" target="_blank"> |
| 70 | + <img src="https://img.shields.io/badge/View%20on%20npm-create--typical--env-CB3837?style=for-the-badge&logo=npm&logoColor=white" alt="View on npm" /> |
| 71 | + </a> |
| 72 | +</p> |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +### Example Output |
| 77 | + |
| 78 | +``` |
| 79 | +╭──────────────────────────────────────────────────────────────╮ |
| 80 | +│ │ |
| 81 | +│ Typical Env Project Setup Tool │ |
| 82 | +│ │ |
| 83 | +│ Instantly sets up a modern React environment with: │ |
| 84 | +│ │ |
| 85 | +│ • React – JavaScript library for building UIs │ |
| 86 | +│ • Vite – Next-generation frontend tooling │ |
| 87 | +│ • Tailwind CSS – Utility-first CSS framework │ |
| 88 | +│ • CLSX – Conditional className utility │ |
| 89 | +│ • Tailwind Merge – Smart merge for Tailwind classes │ |
| 90 | +│ • React Router / DOM – Declarative routing for React │ |
| 91 | +│ • Boxicons – Beautiful icon library │ |
| 92 | +│ • CSS AOS – Animate On Scroll library │ |
| 93 | +│ • Shadcn UI – Reusable components │ |
| 94 | +│ • React Bits – Reusable React components & hooks │ |
| 95 | +│ │ |
| 96 | +│ Create it all instantly with one simple command. │ |
| 97 | +│ │ |
| 98 | +╰──────────────────────────────────────────────────────────────╯ |
| 99 | +``` |
| 100 | + |
| 101 | +--- |
| 102 | + |
| 103 | +### Repository |
| 104 | + |
| 105 | +The source code and template files are available on GitHub: |
| 106 | +[https://github.com/typical-developer/Typical-Env](https://github.com/typical-developer/Typical-Env) |
| 107 | + |
| 108 | +--- |
| 109 | + |
| 110 | +### Contribute |
| 111 | + |
| 112 | +If you find this project useful, you can support it by starring or forking the repository. |
| 113 | + |
| 114 | +<p align="center"> |
| 115 | + <a href="https://github.com/typical-developer/Typical-Env/fork" target="_blank"> |
| 116 | + <img src="https://img.shields.io/badge/Fork%20on%20GitHub-000000?style=for-the-badge&logo=github&logoColor=white" alt="Fork on GitHub" /> |
| 117 | + </a> |
| 118 | + |
| 119 | + <a href="https://github.com/typical-developer/Typical-Env" target="_blank"> |
| 120 | + <img src="https://img.shields.io/badge/Star%20this%20Repo-FFD700?style=for-the-badge&logo=github&logoColor=black" alt="Star this Repo" /> |
| 121 | + </a> |
| 122 | +</p> |
| 123 | + |
| 124 | +--- |
| 125 | + |
| 126 | +### Connect |
| 127 | + |
| 128 | +<p align="center"> |
| 129 | + <a href="https://github.com/typical-developer" target="_blank"> |
| 130 | + <img src="https://img.shields.io/badge/GitHub-typical--developer-181717?style=for-the-badge&logo=github&logoColor=white" alt="GitHub" /> |
| 131 | + </a> |
| 132 | + |
| 133 | + <a href="https://x.com/Chris_Error_404" target="_blank"> |
| 134 | + <img src="https://img.shields.io/badge/X-typicaldevelopr-000000?style=for-the-badge&logo=x&logoColor=white" alt="X Profile" /> |
| 135 | + </a> |
| 136 | +</p> |
0 commit comments