@@ -5,12 +5,15 @@ This directory contains bash scripts to automate the setup process for a React d
55## Quick Start
66
77### Option 1: Run All Steps Automatically
8+
89``` bash
9- ./run_all_steps .sh
10+ ./run_project_setup .sh
1011```
11- This will run all 8 steps with confirmation prompts for each step.
12+
13+ This will run all 8 steps automatically.
1214
1315### Option 2: Run Steps Individually
16+
1417Execute the scripts in order:
1518
1619``` bash
@@ -27,49 +30,62 @@ Execute the scripts in order:
2730## What Each Script Does
2831
2932### Step 1: ` step_01_create_project.sh `
33+
3034- Creates a new Vite React project with TypeScript template
31- - Project name: ` ping-pong-dapp `
35+ - Project files are created directly in the root directory
3236
3337### Step 2: ` step_02_install_dependencies.sh `
38+
3439- Installs the initial project dependencies using yarn
3540
3641### Step 3: ` step_03_install_tailwind.sh `
42+
3743- Installs Tailwind CSS and its dependencies
3844- Creates ` tailwind.config.js `
3945- Creates ` postcss.config.js `
4046
4147### Step 4: ` step_04_configure_eslint_prettier.sh `
48+
4249- Installs ESLint, Prettier, and all related plugins
4350- Creates ` .prettierrc ` configuration
4451- Creates ` eslint.config.js ` with comprehensive rules
4552
4653### Step 5: ` step_05_configure_vite.sh `
54+
4755- Installs Vite plugins (basic SSL, node polyfills, SVGR, tsconfig paths)
4856- Creates ` vite.config.ts ` with development server configuration
4957
5058### Step 6: ` step_06_configure_tsconfig.sh `
59+
5160- Removes extra TypeScript config files
5261- Creates a unified ` tsconfig.json ` with proper settings
5362
5463### Step 7: ` step_07_add_lint_command.sh `
64+
5565- Adds lint script to ` package.json `
5666- Runs the linter to fix any initial issues
5767
5868### Step 8: ` step_08_start_dev_server.sh `
69+
5970- Starts the development server
6071- Server runs on ` https://localhost:3000 `
6172
6273## Prerequisites
6374
6475Before running these scripts, make sure you have:
76+
6577- Node.js (version 16 or higher)
6678- Yarn package manager
6779- Git (optional, for version control)
6880
6981## Project Structure After Setup
7082
71- After running all scripts, you'll have a ` ping-pong-dapp ` directory with:
72- - React + TypeScript setup
83+ After running all scripts, your root directory will contain:
84+
85+ - ` src/ ` - React + TypeScript source files
86+ - ` tutorial/ ` - Tutorial documentation and scripts (existing)
87+ - ` .auto-type/ ` - Auto-type configuration (existing)
88+ - ` package.json ` - Project dependencies and scripts
7389- Tailwind CSS configured
7490- ESLint + Prettier configured
7591- Vite development server with plugins
@@ -78,13 +94,15 @@ After running all scripts, you'll have a `ping-pong-dapp` directory with:
7894## Next Steps
7995
8096After the setup is complete, you can:
81- 1 . Start developing your dApp in the ` ping-pong-dapp ` directory
97+
98+ 1 . Start developing your dApp in the root directory (` src/ ` folder)
82992 . Add MultiversX SDK dependencies for blockchain integration
831003 . Build your ping-pong game logic
84101
85102## Troubleshooting
86103
87104If any script fails:
105+
881061 . Check that you have the required prerequisites
891072 . Make sure you have internet connection for downloading packages
901083 . Ensure you have sufficient disk space
@@ -94,4 +112,4 @@ If any script fails:
94112
95113- All scripts are designed to be idempotent (safe to run multiple times)
96114- The development server (Step 8) will run indefinitely until stopped with Ctrl+C
97- - Each script provides clear success/failure feedback and next step instructions
115+ - Each script provides clear success/failure feedback and next step instructions
0 commit comments