Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
4237b7a
feat: scaffold nextjs project
maxpushka Jul 17, 2025
b38fe76
feat: add CLI tool
maxpushka Jul 17, 2025
2bcd721
fix: make welcome screen responsive
maxpushka Jul 17, 2025
bca4ad6
feat: add ascii art
maxpushka Jul 17, 2025
7cc278e
refactor: make welcome screen persistent
maxpushka Jul 17, 2025
0101a01
feat: exit the process after showing the completion message
maxpushka Jul 17, 2025
fb0d1f2
refactor: drop unused imports
maxpushka Jul 18, 2025
e7ab55e
feat: drop redundant templates
maxpushka Jul 18, 2025
4ccafed
refactor: rename nextjs template
maxpushka Jul 18, 2025
dae8ae7
feat: add NextJS template
maxpushka Jul 18, 2025
c27b533
refactor: update connection status text
maxpushka Jul 18, 2025
46c422f
docs: add README.md for scaffolding tool
maxpushka Jul 18, 2025
725233f
feat: move template selectin before confirmation
maxpushka Jul 18, 2025
7ce8255
fix: privy auth
maxpushka Jul 18, 2025
7196b62
feat: add backend template
maxpushka Jul 21, 2025
a19b794
fix: pass template directly to project generator
maxpushka Jul 21, 2025
6ee64ca
refactor: extract utility functions
maxpushka Jul 21, 2025
bf89f43
refactor: rework nitrolite client
maxpushka Jul 21, 2025
c850b70
refactor: modularize client for maintainability
maxpushka Jul 22, 2025
644da31
refactor: logging cleanup
maxpushka Jul 22, 2025
eb3b675
refactor: remove redundant logs
maxpushka Jul 22, 2025
cd1989f
fix: deduplicate auth_challenge processing
maxpushka Jul 22, 2025
cbbec6e
refactor: drop dependency on express
maxpushka Jul 22, 2025
cc7ad6b
refactor: drop dependency on ethers
maxpushka Jul 22, 2025
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
33 changes: 33 additions & 0 deletions sdk/create-nitrolite-app/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Build output
dist/

# Auto-generated constants
src/constants/version.ts

# Dependencies
node_modules/

# Logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Coverage directory used by tools like istanbul
coverage/

# IDE
.vscode/
.idea/

# OS
.DS_Store
Thumbs.db

# TypeScript
*.tsbuildinfo
132 changes: 132 additions & 0 deletions sdk/create-nitrolite-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# create-nitrolite-app

A CLI tool to quickly create new Nitrolite applications with various templates and configurations.

## Usage

### Interactive Mode (Recommended)

```bash
npx create-nitrolite-app
```

### Quick Start

```bash
# Create with default template
npx create-nitrolite-app my-app

# Create with specific template
npx create-nitrolite-app my-app --template nextjs-app

# Skip prompts and use defaults
npx create-nitrolite-app my-app --yes
```

### Advanced Usage

```bash
# Create without git initialization
npx create-nitrolite-app my-app --no-git

# Create without installing dependencies
npx create-nitrolite-app my-app --no-install

# Combine options
npx create-nitrolite-app my-app --template nextjs-app --no-git --yes
```

## Available Templates

### `nextjs-app`

- Next.js 15 with App Router
- TypeScript and TailwindCSS
- Server-side rendering
- Optimized for production

## CLI Options

| Option | Description | Default |
| ------------------- | ---------------------------- | ------------ |
| `--template <name>` | Template to use | `react-vite` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The default template in the CLI options table is react-vite, but this template isn't described in the "Available Templates" section and is not included in the pull request. This inconsistency could confuse users.

| `--no-git` | Skip git initialization | `false` |
| `--no-install` | Skip dependency installation | `false` |
| `--yes` | Skip prompts, use defaults | `false` |
| `--help` | Show help | - |
| `--version` | Show version | - |

## Development

### Build

```bash
npm run build
```

### Development

```bash
npm run dev
```

### Test

```bash
npm test
```

## Project Structure

```
my-nitrolite-app/
├── src/
│ ├── components/ # React/Vue components
│ ├── hooks/ # Custom hooks (React)
│ ├── composables/ # Composables (Vue)
│ ├── utils/ # Utility functions
│ └── main.tsx # Entry point
├── public/ # Static assets
├── package.json
└── README.md
```
Comment on lines +81 to +92
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The project structure example seems to be for a Vite-based project (e.g., src/main.tsx, src/hooks/). This doesn't match the nextjs-app template, which uses an app/ directory. This could be misleading.


## Next Steps

After creating your project:

1. **Navigate to your project**:

```bash
cd my-nitrolite-app
```

2. **Install dependencies** (if not done automatically):

```bash
npm install
```

3. **Start development server**:

```bash
npm run dev
```

4. **Configure your WebSocket endpoint** in the config file

5. **Start building your Nitrolite application**!

## Documentation

- [Nitrolite SDK Documentation](https://github.com/erc7824/nitrolite)
- [Examples](../../examples/)
- [Issue Tracker](https://github.com/erc7824/nitrolite/issues)

## Contributing

Contributions are welcome! Please read the contributing guide in the main repository.

## License

ISC License - see the main repository for details.
Loading
Loading