Nespo.dev

Quick Start

Get up and running with Nespo.dev in just a few minutes.

Installation

1. Clone the Repository

git clone <repository-url>
cd nespo

2. Install Dependencies

Nespo.dev uses pnpm as the package manager for optimal workspace management.

pnpm install

3. Set Up Environment Variables

Copy the example environment files and configure them:

# API environment
cp apps/api/.env.example apps/api/.env

# Web environment
cp apps/web/.env.example apps/web/.env

Edit the .env files with your configuration:

  • Database connection string
  • API keys for third-party services
  • OAuth credentials
  • JWT secrets

4. Start the Database

Using Docker Compose:

docker-compose up -d postgres

Or use your own PostgreSQL instance (v14+).

5. Run Database Migrations

cd apps/api
pnpm prisma:migrate

6. Start Development Servers

From the root directory:

# Start all applications
pnpm dev

# Or start individual apps
pnpm dev:api    # Backend API
pnpm dev:web    # Web application
pnpm dev:mobile # Mobile application

Access Your Applications

Once running, access your applications at:

Project Structure

nespo/
├── apps/
│   ├── web/          # Next.js web application
│   ├── mobile/       # Expo mobile app
│   └── api/          # NestJS backend API
├── packages/
│   ├── api-client/   # Auto-generated API client
│   └── types/        # Shared TypeScript types
├── turbo.json        # TurboRepo configuration
└── package.json      # Root package configuration

Common Commands

Development

pnpm dev              # Run all apps in dev mode
pnpm dev:api          # Run API only
pnpm dev:web          # Run web app only
pnpm dev:mobile       # Run mobile app only

Building

pnpm build            # Build all apps
pnpm build:api        # Build API only
pnpm build:web        # Build web app only

Testing

pnpm test             # Run all tests
pnpm test:api         # Test API only
pnpm test:web         # Test web app only

Database

cd apps/api
pnpm prisma:migrate   # Run migrations
pnpm prisma:studio    # Open Prisma Studio
pnpm prisma:generate  # Generate Prisma Client

Next Steps

Now that you have Nespo.dev running:

  1. Customize the branding - Update colors, logos, and styling
  2. Explore the code - Understand the architecture and patterns
  3. Add your features - Build on top of the solid foundation
  4. Deploy to production - Use our deployment guides

Check out the Prerequisites to ensure your environment is properly configured, or dive into the Architecture to understand how everything works together.

Need Help?