Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 46 additions & 4 deletions QUICK_START.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,27 @@ Before you begin, ensure you have:

## Quick Start Commands

### 🎯 First-Time Setup
### ⚡ Fastest Way - Using npm

The simplest way to get started using npm scripts:

```bash
# 1. Validate configuration
npm run check

# 2. Install dependencies
npm run install:all

# 3. Start all services
npm start
```

### 🎯 First-Time Setup (Detailed)

1. **Validate Configuration**
```bash
npm run check
# or
bash start-all-phases.sh --check
```

Expand All @@ -32,16 +49,24 @@ nano mini-app/.env

2. **Install Dependencies**
```bash
npm run install:all
# or
bash start-all-phases.sh --install
```

3. **Validate Again**
```bash
npm run check
# or
bash start-all-phases.sh --check
```

### 🎯 Start Everything (Recommended)
```bash
npm start
# or
npm run start:all
# or
bash start-all-phases.sh --all
```

Expand All @@ -55,6 +80,8 @@ This will:

### 📊 Check Status
```bash
npm run status
# or
bash start-all-phases.sh --status
```

Expand All @@ -65,13 +92,17 @@ Shows:

### 🛑 Stop All Services
```bash
npm run stop
# or
bash start-all-phases.sh --stop
```

Cleanly stops all running services.

### 📦 Install Dependencies Only
```bash
npm run install:all
# or
bash start-all-phases.sh --install
```

Expand All @@ -81,11 +112,15 @@ Installs dependencies without starting services.

### Backend Only
```bash
npm run start:backend
# or
bash start-all-phases.sh --backend
```

### Frontend Only
```bash
npm run start:frontend
# or
bash start-all-phases.sh --frontend
```

Expand Down Expand Up @@ -187,6 +222,8 @@ lsof -i :3000
kill -9 <PID>

# Or use the stop command
npm run stop
# or
bash start-all-phases.sh --stop
```

Expand All @@ -196,6 +233,8 @@ bash start-all-phases.sh --stop
npm cache clean --force

# Try installing again
npm run install:all
# or
bash start-all-phases.sh --install
```

Expand All @@ -214,17 +253,20 @@ All logs are stored in `Logs/` directory:

## Next Steps

1. ✅ Run `bash start-all-phases.sh --check` to validate setup
1. ✅ Run `npm run check` (or `bash start-all-phases.sh --check`) to validate setup
2. ✅ Configure `.env` files using the `.env.example` templates
3. ✅ Run `bash start-all-phases.sh --all`
3. ✅ Run `npm start` (or `bash start-all-phases.sh --all`)
4. ✅ Test backend API at http://localhost:3000/health
5. ✅ Test mini-app on your device
6. ✅ Check `PHASE_STATUS.md` for development roadmap

## Getting Help

```bash
# Show all available options
# Show all available npm scripts
npm run

# Show all script options
bash start-all-phases.sh --help
```

Expand Down
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,9 +236,32 @@ Create a `.env` file in both `mini-app/` and `server/` directories:

#### Quick Start - All Phases (Recommended)

**Automated Startup Script**
**Automated Startup with npm (Easiest)**

The easiest way to start all components at once:
The simplest way to start all components using npm scripts:

```bash
# First-time setup: Validate configuration
npm run check

# Install dependencies for all components
npm run install:all

# Start all services (backend + frontend)
npm start
# or
npm run start:all

# Or for specific components:
npm run start:backend # Backend only
npm run start:frontend # Frontend only
npm run status # Check status
npm run stop # Stop all services
```

**Alternative: Direct Script Usage**

You can also run the script directly:

```bash
# First-time setup: Validate configuration
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 14 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,20 @@
{
"name": "demo-repo",
"version": "0.2.0",
"description": "A sample package.json",
"name": "zeazdev",
"version": "1.0.0",
"description": "ZeaZDev - World App Mini App with World ID verification for Sybil-resistant rewards and DeFi features",
"scripts": {
"start": "bash start-all-phases.sh --all",
"start:all": "bash start-all-phases.sh --all",
"start:backend": "bash start-all-phases.sh --backend",
"start:frontend": "bash start-all-phases.sh --frontend",
"check": "bash start-all-phases.sh --check",
"install:all": "bash start-all-phases.sh --install",
"status": "bash start-all-phases.sh --status",
"stop": "bash start-all-phases.sh --stop"
},
"dependencies": {
"@primer/css": "17.0.1"
},
"author": "PHIPHAT PHOEMSUK (ZeaZDev)",
"license": "MIT"
}