A simple CLI tool to quickly scaffold a React TypeScript project with Tailwind CSS and React Router.
npm install basic-react-toolkitbash
Create a new project
npx basic-react-toolkit my-awesome-app
Navigate to your project
cd my-awesome-app
Start development server
npm start
`
What's Included
Your new project will have:
- Modern React setup with functional components and hooks
- TypeScript configuration with JSX support
- Tailwind CSS with PostCSS integration
- React Router with basic routing examples
- Development server with hot reloading
- Production build setup
Project Structure
`
my-app/
āāā index.html # Entry HTML file
āāā package.json # Dependencies and scripts
āāā tailwind.config.js # Tailwind configuration
āāā .postcssrc # PostCSS configuration
āāā tsconfig.json # TypeScript configuration
āāā src/
āāā index.tsx # React entry point
āāā App.tsx # Main App component
āāā index.css # Tailwind CSS imports
`
Available Scripts
In your project directory, you can run:
$3
Runs the app in development mode with hot reloading.
Open http://localhost:1234 to view it in the browser.
$3
Builds the app for production to the dist folder.
The build is minified and optimized for the best performance.
Usage Examples
$3
`bash
npx basic-react-toolkit
`
Creates a project named my-app in the current directory.
$3
`bash
npx basic-react-toolkit my-custom-project
`
Creates a project with your specified name.
Tech Stack
- React: Frontend library for building user interfaces
- TypeScript: Type-safe JavaScript
- Tailwind CSS: Utility-first CSS framework
- React Router: Declarative routing for React
- Parcel: Zero-configuration build tool
Requirements
- Node.js 14 or higher
- npm or yarn
Customization
After creating your project, you can:
1. Modify Tailwind configuration in tailwind.config.js
2. Add new routes in src/App.tsx
3. Install additional dependencies as needed
4. Configure TypeScript in tsconfig.json
Example Code
The generated project includes a simple example with routing:
`tsx
// src/App.tsx
import React from "react";
import { Route, Routes, Link } from "react-router-dom";
export default function App() {
return (
Hello React + TS + Tailwind + Router š
Home Page } />
About Page