@matarazy28/create-react-template v0.0.6

Vanilla React Template

A minimal and fast React template powered by Vite, designed to kickstart your React projects with sensible defaults.

Features

• Fast Development: Utilizes Vite for rapid development and hot module replacement.
• Modern JavaScript: Built with the latest features of JavaScript, including ES6+ syntax.
• Preconfigured: Comes with a basic configuration out of the box to help you get started quickly.
• Lightweight: Minimal dependencies to keep your project lightweight and performant.

Getting Started

Prerequisites

Make sure you have the following installed:

• Node.js (v18 or higher)
• npm (comes with Node.js)

Documentation

For more detailed instructions and advanced usage, please visit the Vanilla React Template Documentation.

Installation

You can easily create a new project using this template with the following command:

npx @matarazy28/create-react-template@latest

During the installation, you'll be prompted to enter:

• App Name: Enter your desired application name (default is my-app).
• Port Number: Specify the port number on which you want to run your development server (default is 8001).

Usage

cd your-app-name
npm run dev

Open your browser and visit http://localhost:your-port-number to see your app in action!

Customization

You can customize your template by modifying the following files:

• package.json: Update project metadata, dependencies, and scripts.
• vite.config.ts: Configure Vite options and server settings.
• src/: This is where your application code resides. You can add components, styles, and assets here.

Contributing

Contributions are welcome! If you have suggestions for improvements, please feel free to submit a pull request or open an issue.

Acknowledgments

• Vite - The build tool that powers this template.
• React - The library for building user interfaces.

Key Changes

1. Installation Section: I've included details about the prompts for the app name and port number during the installation process.
2. Clear Instructions: The instructions are clear, making it easy for users to understand what to expect when they run the installation command.

Feel free to modify any additional sections to suit your project’s needs!