spaps
Version:
Sweet Potato Authentication & Payment Service CLI - Zero-config local development and project scaffolding
82 lines (61 loc) ⢠1.74 kB
Markdown
# spaps
> Sweet Potato Authentication & Payment Service CLI
Zero-config local development for SPAPS authentication and payments.
## Quick Start
```bash
npx spaps local
```
That's it! Your local SPAPS server is running at http://localhost:3300 š
⨠**New in v0.2.0**: The `spaps local` command now starts a real server!
## Installation
```bash
npm install -g spaps
# or
yarn global add spaps
```
## Commands
### `spaps local`
Start a local SPAPS development server with:
- No API keys required
- Auto-authentication enabled
- Test users (user/admin/premium)
- CORS configured for any frontend
- Mock Stripe endpoints
- Full auth flow support
```bash
spaps local
# Server running at http://localhost:3300
# Documentation at http://localhost:3300/docs
# Options:
spaps local --port 3301 # Use different port
spaps local --open # Open browser automatically
```
### `spaps init`
Initialize SPAPS in an existing project:
```bash
spaps init
# Creates .env.local with minimal config
# Adds SPAPS SDK to package.json
```
### `spaps create <name>` (Coming Soon)
Create a new project with SPAPS pre-configured:
```bash
spaps create my-app
# Choose framework: Next.js, React, Node.js
# Includes authentication examples
```
### `spaps types` (Coming Soon)
Generate TypeScript types from your SPAPS setup:
```bash
spaps types > types/spaps.d.ts
```
## Local Mode Features
- **Zero Configuration**: Just run and go
- **Auto Authentication**: No API keys needed
- **Test Users**: Switch between user/admin/premium
- **CORS Enabled**: Works with any frontend
- **Production Safe**: Can't accidentally run in production
## Documentation
Full documentation at [sweetpotato.dev](https://sweetpotato.dev)
## License
MIT