Skip to content

alvaro-escalante/project-init-script

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Initialization Script

This repository includes a Bash script designed to automate the setup of a new React project using Vite with SWC and a suite of tools for efficient development and testing.

Features

  • Sets up a new React project using Vite with a TypeScript template.
  • Creates necessary directories and navigates into the project.
  • Adds the @vitejs/plugin-react-swc plugin for fast refresh using SWC.
  • Installs ESLint with TypeScript support and relevant plugins for code linting.
  • Installs Vitest and Testing Library for robust unit and integration testing.
  • Sets up Prettier for consistent code formatting.
  • Configures convenient package scripts for development and testing.
  • Generates configuration files for Vite, ESLint, Prettier, and Vitest with sensible defaults.

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • Node.js (v20.9.0 or later)
  • pnpm
  • jq for processing JSON
  • A Unix-like environment if you're on Windows (e.g., WSL, Git Bash)

Usage

To use the script, follow these steps:

  1. Clone the repository or download the script to your local machine.

  2. Make the script executable by running the following command:

    chmod +x setup_project.sh
  3. Run the bash file:

    ./setup_project.sh
  4. Choose the poject folder:

    Project path: /path/to/folder
  5. Type a project name

    Project name: Project name
    

The script will execute all steps and provide output on the terminal as it progresses.

About

A collection of bash files to automate the generation of fullstack projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages