Giter Club home page Giter Club logo

project-init-script's Introduction

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.

project-init-script's People

Contributors

alvaro-escalante avatar a-fernandez-naves avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.