Skip to content

Vite Express CLI โ€“ Ein einfaches CLI-Tool zum Erstellen einer Full-Stack-Projektstruktur mit Vite (React + TypeScript) und Express (TypeScript). ๐Ÿš€

License

Notifications You must be signed in to change notification settings

LennardGeissler/vite-express-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

4 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ vite-express-cli

This script provides a command-line utility for quickly scaffolding a full-stack application with a Vite client (React, TypeScript) and an Express server (TypeScript). It generates the necessary folder structure, installs dependencies, and sets up basic configurations.

๐Ÿ› ๏ธ Features

  • Client Setup:

    • Vite with React and TypeScript template โš›๏ธ๐Ÿ’ป
    • React with SWC support for faster builds โšก
    • Pre-configured client-side folder structure ๐Ÿ—‚๏ธ
  • Server Setup:

    • Express server with TypeScript ๐Ÿ–ฅ๏ธ๐Ÿ”ง
    • TypeScript configuration for the server ๐Ÿ“œ
    • Pre-configured server-side folder structure ๐Ÿ—‚๏ธ
    • Includes nodemon for automatic server restarts during development ๐Ÿ”„
  • Standard Files:

    • README.md ๐Ÿ“–
    • LICENSE (MIT License) ๐Ÿ“
    • .gitignore for ignoring node_modules, build artifacts, and environment files ๐Ÿšซ

๐Ÿ“‚ Project Structure

  • client/: Contains the client-side code, set up with Vite, React, and TypeScript.
  • server/: Contains the server-side code, set up with Express and TypeScript.

๐Ÿ–ฅ๏ธ Client Folder Structure

client/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ assets/              # Static assets ๐Ÿ–ผ๏ธ
โ”‚   โ”œโ”€โ”€ components/          # Reusable components ๐Ÿ”ง
โ”‚   โ”œโ”€โ”€ hooks/               # Custom React hooks ๐Ÿ”„
โ”‚   โ”œโ”€โ”€ services/            # Client-side API services ๐ŸŒ
โ”‚   โ”œโ”€โ”€ types/               # TypeScript types ๐Ÿท๏ธ
โ”‚   โ”œโ”€โ”€ utils/               # Utility functions ๐Ÿ› ๏ธ

๐Ÿ–ฅ๏ธ Server Folder Structure

server/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ models/              # Data models ๐Ÿ—‚๏ธ
โ”‚   โ”œโ”€โ”€ controllers/         # Request handling logic ๐ŸŽฎ
โ”‚   โ”œโ”€โ”€ routes/              # API route definitions ๐Ÿšฆ
โ”‚   โ”œโ”€โ”€ services/            # Server-side services ๐ŸŒ
โ”‚   โ”œโ”€โ”€ middlewares/         # Express middlewares ๐Ÿ”
โ”‚   โ”œโ”€โ”€ types/               # TypeScript types ๐Ÿท๏ธ
โ”‚   โ”œโ”€โ”€ utils/               # Utility functions ๐Ÿ› ๏ธ

๐Ÿ“ฆ Execution

As this script was published as an npm package, you can execute it directly via the command line with

npx vite-express-cli <your-project-name>

๐Ÿ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Authors

  • Lennard GeiรŸler (@LennardGeissler)

About

Vite Express CLI โ€“ Ein einfaches CLI-Tool zum Erstellen einer Full-Stack-Projektstruktur mit Vite (React + TypeScript) und Express (TypeScript). ๐Ÿš€

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published