preapexis-starter
v1.1.6
Published
A command-line tool to quickly set up a new React project with TypeScript, SWC, and Tailwind CSS using Vite
Downloads
186
Maintainers
Readme
PreApeXis-UI-Starter
A command-line tool to quickly set up a new React project with TypeScript, SWC, and Tailwind CSS using Vite. This starter package is designed to streamline the setup process and get you up and running with a modern development environment.
Features
Vite: A fast build tool and development server. React: A popular library for building user interfaces. TypeScript: A typed superset of JavaScript for better development experience. SWC: A fast TypeScript/JavaScript compiler. Tailwind CSS: A utility-first CSS framework for rapid UI development. Installation You can use npx to run the package without installing it globally:
npx preapexis-starter@latest
Replace my-new-project with your desired project name.
Usage Create a New Project
Run the following command to create a new project:
npx preapexis-ui@latest create my-new-project
Replace my-new-project with your desired project name.
Navigate to Your Project
Change to the project directory:
cd my-new-project
Install Dependencies
Install the required dependencies:
npm install
Start the Development Server
Run the development server:
npm run dev
Open your browser and go to http://localhost:5173 to see your new React app.
Configuration
Vite The Vite configuration is located in vite.config.ts. You can customize the Vite settings as needed for your project.
Tailwind CSS Tailwind CSS is configured in tailwind.config.js. You can add custom colors, fonts, and other settings here.
SWC SWC is used for compiling TypeScript and JavaScript. Configuration can be found in .swcrc.
Scripts
npm run dev: Starts the development server. npm run build: Builds the project for production. npm run lint: Lints the codebase. Contributing If you want to contribute to this project, please fork the repository and submit a pull request with your changes. For detailed guidelines, see CONTRIBUTING.md.
License
This project is licensed under the MIT License.
Contact For questions or feedback, please reach out to [email protected].
Enjoy building with Vite, React, TypeScript, SWC, and Tailwind CSS!