Wasp

https://wasp.sh/docs
Admin
Wasp is an opinionated full-stack web framework that simplifies building modern web applications. It...
Tokens:152,512
Snippets:1,580
Trust Score:7.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Migrate to npm installation

Source: https://wasp.sh/docs/guides/legacy/installer

Run the migration tool to switch from the legacy installer to the npm-based installation method.

```bash
curl -sSL https://get.wasp.sh/installer.sh | sh -s -- migrate-to-npm  
```

--------------------------------

### Define Client Setup Function

Source: https://wasp.sh/docs/api/@wasp.sh/spec/interfaces/Client

Example of an asynchronous function used for one-time client-side initialization.

```typescript
export default async function mySetupFunction(): Promise<void> {  

  // Run some code  

}  
```

--------------------------------

### Define a client setup function

Source: https://wasp.sh/docs/project/client-config

A basic setup function that executes logic upon client initialization.

```javascript
export default async function mySetupFunction() {  

  let count = 1  

  setInterval(  

    () => console.log(`You have been online for ${count++} hours.`),  

    1000 * 60 * 60  

  )  

}  
```

```typescript
export default async function mySetupFunction(): Promise<void> {  

  let count = 1  

  setInterval(  

    () => console.log(`You have been online for ${count++} hours.`),  

    1000 * 60 * 60  

  )  

}  
```

--------------------------------

### Start local production build server

Source: https://wasp.sh/docs/deployment/local-testing

Commands to initialize the local database and start the production build server with required environment variables.

```bash
# Start a local database, copy the connection URL  

wasp start db  

  

# Start the local production build server  

# (this is an example, you'll probably need to add more environment variables)  

wasp build start --server-env DATABASE_URL=<your-database-url> --server-env JWT_SECRET=<your-jwt-secret>
```

--------------------------------

### Configure Client with Setup Function

Source: https://wasp.sh/docs/project/client-config

Register a custom setup function and root component in the app specification.

```TypeScript

import { app } from "@wasp.sh/spec"  

import Root from "./src/Root" with { type: "ref" }  

import mySetupFunction from "./src/myClientSetupCode" with { type: "ref" }  

  

export default app({  

  name: "MyApp",  

  client: {  

    rootComponent: Root,  

    setupFn: mySetupFunction,  

  },  

  // ...  

})  



```

--------------------------------

### Setup Fly.io configuration

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly

Registers the app on Fly and generates configuration files. Run only once.

```bash
wasp deploy fly setup <app-name> <region>
```

--------------------------------

### Customize Wasp development database

Source: https://wasp.sh/docs/data-model/databases

Examples of starting the Wasp development database with custom Docker images and volume configurations.

```bash
# Use default PostgreSQL image:  

wasp start db  

# Same as:  

wasp start db --db-image postgres:18  

  

# Use PostgreSQL with PostGIS extension for geographic data:  

wasp start db --db-image postgis/postgis:18-3.6   

  

# Use PostgreSQL with pgvector extension for AI embeddings:  

wasp start db --db-image pgvector/pgvector:pg18  

  

# Use PostgreSQL version 15 (requires different volume path):  

wasp start db --db-image postgres:15 --db-volume-mount-path /var/lib/postgresql/data
```

--------------------------------

### Start Server Container

Source: https://wasp.sh/docs/guides/deployment/self-hosted/vps

Run the application server container with environment variables.

```bash
docker run -d \
  --name myapp-server \
  --env-file .env.production \
  -p 127.0.0.1:3001:3001 \
  --network myapp-network \
  myapp-server
```

--------------------------------

### Implement Custom Route in Setup Function

Source: https://wasp.sh/docs/project/server-config

Add custom Express routes during server startup using the setup function.

```JavaScript
export const mySetupFunction = async ({ app }) => {  

  addCustomRoute(app)  

}  

  

function addCustomRoute(app) {  

  app.get("/customRoute", (_req, res) => {  

    res.send("I am a custom route")  

  })  

}
```

```TypeScript
import { ServerSetupFn } from "wasp/server"  
import { Application } from "express"  

  

export const mySetupFunction: ServerSetupFn = async ({ app }) => {  

  addCustomRoute(app)  

}  

  

function addCustomRoute(app: Application) {  

  app.get("/customRoute", (_req, res) => {  

    res.send("I am a custom route")  

  })  

}
```

--------------------------------

### Store Resources in Setup Function

Source: https://wasp.sh/docs/project/server-config

Initialize and store resources during server startup to be accessed by operations.

```JavaScript
let someResource = undefined  

  

export const mySetupFunction = async () => {  

  // Let's pretend functions setUpSomeResource and startSomeCronJob  

  // are implemented below or imported from another file.  

  someResource = await setUpSomeResource()  

  startSomeCronJob()  

}  

  

export const getSomeResource = () => someResource
```

```JavaScript
import { getSomeResource } from "./myServerSetupCode.js"  

  

...  

  

export const someQuery = async (args, context) => {  

  const someResource = getSomeResource()  

  return queryDataFromSomeResource(args, someResource)  

}
```

```TypeScript
import { type ServerSetupFn } from "wasp/server"  

  

let someResource = undefined  

  

export const mySetupFunction: ServerSetupFn = async () => {  

  // Let's pretend functions setUpSomeResource and startSomeCronJob  

  // are implemented below or imported from another file.  

  someResource = await setUpSomeResource()  

  startSomeCronJob()    

}  

  

export const getSomeResource = () => someResource
```

```TypeScript
import { type SomeQuery } from "wasp/server/operations"  
import { getSomeResource } from "./myServerSetupCode.js"  

  

...  

  

export const someQuery: SomeQuery<...> = async (args, context) => {  

  const someResource = getSomeResource()  

  return queryDataFromSomeResource(args, someResource)  

}
```

--------------------------------

### Define Server Setup Function

Source: https://wasp.sh/docs/api/%40wasp.sh/spec/interfaces/Server

Implement an asynchronous setup function using the ServerSetupFn type for server initialization.

```typescript
import { type ServerSetupFn } from "wasp/server"  

  

export const mySetupFunction: ServerSetupFn = async () => {  

  await setUpSomeResource()  

}  
```

--------------------------------

### Verify Docker Installation

Source: https://wasp.sh/docs/guides/deployment/self-hosted/vps

Run the hello-world container to confirm Docker is operational.

```bash
docker run hello-world
```

--------------------------------

### Install Node.js via NVM

Source: https://wasp.sh/docs/guides/deployment/self-hosted/vps

Install Node.js using the Node Version Manager.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
source ~/.bashrc
nvm install 24.14.1
```

--------------------------------

### Install Sentry SDKs

Source: https://wasp.sh/docs/guides/integrations/sentry

Install the required Sentry packages for Node.js and React environments.

```bash
npm install @sentry/node @sentry/react
```

--------------------------------

### Start Wasp Application

Source: https://wasp.sh/docs/guides/debugging/local-network-testing

Command to initiate the Wasp development server.

```bash
wasp start
```

--------------------------------

### Launch a Wasp app on Fly.io

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly

Runs setup, database creation, and deployment in one command.

```bash
wasp deploy fly launch <app-name> <region>
```

--------------------------------

### Start PostgreSQL Container

Source: https://wasp.sh/docs/guides/deployment/self-hosted/vps

Launch the database container within the application network.

```bash
docker run -d \
  --name myapp-db \
  -e POSTGRES_PASSWORD=mysecretpassword \
  -e POSTGRES_DB=myapp \
  -v postgres_data:/var/lib/postgresql \
  --network myapp-network \
  postgres:18
```

--------------------------------

### Example DNS record output

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly

This is an example of the output provided by the Fly CLI for configuring DNS records.

```text
You can direct traffic to mycoolapp.com by:  

  

1: Adding an A record to your DNS service which reads  

  

    A @ 66.241.1XX.154  

  

You can validate your ownership of mycoolapp.com by:  

  

2: Adding an AAAA record to your DNS service which reads:  

  

    AAAA @ 2a09:82XX:1::1:ff40
```

--------------------------------

### wasp deploy fly setup

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly

Registers client and server apps on Fly and sets up environment variables.

```APIDOC
## wasp deploy fly setup <app-name> <region>

### Description
Registers your client and server apps on Fly and sets up needed environment variables. This should only be run once.

### Parameters
- **app-name** (string) - Required - The name of your app.
- **region** (string) - Required - The region where your app will be deployed.

### Options
- **--fly-toml-dir** (string) - Optional - Path to directory containing fly-server.toml and fly-client.toml.
```

--------------------------------

### Install Wasp via npm

Source: https://wasp.sh/docs/guides/legacy/installer

Install the latest or a specific version of the Wasp CLI using npm.

```bash
npm i -g @wasp.sh/wasp-cli@latest  
```

```bash
# Set x.y.z to the version you want to install, e.g. 0.20.2  

npm i -g @wasp.sh/wasp-cli@x.y.z  
```

--------------------------------

### Install Swagger UI dependencies

Source: https://wasp.sh/docs/guides/integrations/swagger-ui

Install the necessary runtime and development type packages for Swagger integration.

```bash
npm install swagger-jsdoc swagger-ui-express  

npm install --save-dev @types/swagger-jsdoc @types/swagger-ui-express
```

--------------------------------

### Install Agent Plugins

Source: https://wasp.sh/docs/quick-start

Commands to add Wasp knowledge to AI coding agents.

```bash
claude plugin marketplace add wasp-lang/wasp-agent-plugins

claude plugin install wasp@wasp-agent-plugins --scope project
```

```bash
npx skills add wasp-lang/wasp-agent-plugins
```

--------------------------------

### Define Server Environment Variables

Source: https://wasp.sh/docs/project/env-vars

Example content for the .env.server file located in the project root.

```text
DATABASE_URL=postgresql://localhost:5432  

SOME_VAR_NAME=somevalue  

```

--------------------------------

### Create and Run a Wasp App

Source: https://wasp.sh/docs/quick-start

Commands to initialize a new project and start the development server.

```bash
wasp new
```

```bash
cd <my-project-name>

wasp start
```

--------------------------------

### Define routes with prerendering

Source: https://wasp.sh/docs/api/@wasp.sh/spec/interfaces/Route

Example showing how to define routes with static and dynamic prerendering configurations.

```typescript
import { app, page, route } from "@wasp.sh/spec"  

import { LandingPage } from "./src/LandingPage" with { type: "ref" }  

import { BlogPostPage } from "./src/BlogPostPage" with { type: "ref" }  

  

export default app({  

  // ...  

  spec: [  

    route("LandingRoute", "/", page(LandingPage), {  

      prerender: true,  

    }),  

    route("BlogPostRoute", "/blog/:slug", page(BlogPostPage), {  

      prerender: ["/blog/intro", "/blog/changelog"],  

    }),  

  ],  

})
```

--------------------------------

### Build Wasp Application

Source: https://wasp.sh/docs/guides/deployment/self-hosted/vps

Install dependencies and build the application artifacts.

```bash
wasp install
wasp build
```

--------------------------------

### Define Client Environment Variables

Source: https://wasp.sh/docs/project/env-vars

Example content for the .env.client file, requiring the REACT_APP_ prefix.

```text
REACT_APP_SOME_VAR_NAME=somevalue  

```

--------------------------------

### Define Prisma Setup Function

Source: https://wasp.sh/docs/data-model/databases

Implement a function that returns a configured Prisma Client instance with logging and extensions.

```javascript
import { PrismaClient } from "@prisma/client"  

  

export const setUpPrisma = () => {  

  const prisma = new PrismaClient({  

    log: ["query"],  

  }).$extends({  

    query: {  

      task: {  

        async findMany({ args, query }) {  

          args.where = {  

            ...args.where,  

            description: { not: { contains: "hidden by setUpPrisma" } },  

          }  

          return query(args)  

        },  

      },  

    },  

  })  

  

  return prisma  

}  
```

```typescript
import { PrismaClient } from "@prisma/client"  

  

export const setUpPrisma = () => {  

  const prisma = new PrismaClient({  

    log: ["query"],  

  }).$extends({  

    query: {  

      task: {  

        async findMany({ args, query }) {  

          args.where = {  

            ...args.where,  

            description: { not: { contains: "hidden by setUpPrisma" } },  

          }  

          return query(args)  

        },  

      },  

    },  

  })  

  

  return prisma  

}  
```

--------------------------------

### Manage Node.js with NVM

Source: https://wasp.sh/docs/quick-start

Commands for installing, selecting, and verifying Node.js versions using NVM.

```bash
nvm install 24
```

```bash
nvm use 24
```

```bash
node -v
```

--------------------------------

### Configure Client-Side Sentry

Source: https://wasp.sh/docs/guides/integrations/sentry

Initialize Sentry for the client side. The setup function must be exported even if empty.

```javascript
import * as Sentry from "@sentry/react";  

  

Sentry.init({  

  dsn: import.meta.env.REACT_APP_SENTRY_CLIENT_DSN,  

  environment: import.meta.env.MODE,  

  tracesSampleRate: 1.0,  

});  

  

export const setupClient = async () => {  

  // Sentry is initialized above, before the setup function runs.  

  // You can add additional client-side setup here if needed.  

};
```

```typescript
import * as Sentry from "@sentry/react";  

  

Sentry.init({  

  dsn: import.meta.env.REACT_APP_SENTRY_CLIENT_DSN,  

  environment: import.meta.env.MODE,  

  tracesSampleRate: 1.0,  

});  

  

export const setupClient = async () => {  

  // Sentry is initialized above, before the setup function runs.  

  // You can add additional client-side setup here if needed.  

};
```

--------------------------------

### wasp deploy fly launch

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly

Runs setup, create-db, and deploy in sequence to launch an application on Fly.io.

```APIDOC
## wasp deploy fly launch <app-name> <region>

### Description
Convenience command that runs setup, create-db, and deploy in sequence.

### Parameters
- **app-name** (string) - Required - The name of your app.
- **region** (string) - Required - The region where your app will be deployed.

### Options
- **--server-secret** (string) - Optional - Set server environment variables (e.g., GOOGLE_CLIENT_ID=<...>).
- **--custom-server-url** (string) - Optional - Set a custom server URL for the client.
```

--------------------------------

### Configure Server with app

Source: https://wasp.sh/docs/api/%40wasp.sh/spec/interfaces/Server

Define server-side configuration using the app function, including setup and middleware functions.

```typescript
import { app } from "@wasp.sh/spec"  

import { myMiddlewareConfigFn, mySetupFunction } from "./src/myServerSetupCode" with { type: "ref" }  

  

export default app({  

  // ...  

  server: {  

    setupFn: mySetupFunction,  

    middlewareConfigFn: myMiddlewareConfigFn,  

  },  

})  
```

--------------------------------

### Use legacy installer

Source: https://wasp.sh/docs/guides/legacy/installer

Install a specific version of Wasp using the legacy script installer. A version argument is required.

```bash
# Set x.y.z to the version you want to install, e.g. 0.20.1  

# The installer will refuse to run without a specific version argument  

curl -sSL https://get.wasp.sh/installer.sh | sh -s -- -v x.y.z  
```

--------------------------------

### Initialize a project with the OpenSaaS template

Source: https://wasp.sh/docs/project/starter-templates

Use the -t flag to specify the saas template directly.

```bash
wasp new <project-name> -t saas
```

--------------------------------

### Verify Wasp Installation

Source: https://wasp.sh/docs/guides/deployment/self-hosted/vps

Check the installed Wasp version.

```bash
wasp version
```

--------------------------------

### Install Multer Dependencies

Source: https://wasp.sh/docs/guides/integrations/file-upload

Install the Multer package and its corresponding TypeScript definitions.

```bash
npm install multer  

npm install --save-dev @types/multer  
```

--------------------------------

### Initialize a project with the minimal template

Source: https://wasp.sh/docs/project/starter-templates

Use the -t flag to specify the minimal template directly.

```bash
wasp new <project-name> -t minimal
```

--------------------------------

### Initialize Shadcn

Source: https://wasp.sh/docs/guides/libraries/shadcn

Run the Shadcn CLI to initialize the project with Radix and Luma presets.

```bash
npx shadcn@latest init -b radix -p luma  
```

--------------------------------

### Install Wasp CLI

Source: https://wasp.sh/docs/migration-guide

Commands to install the latest or a specific version of the Wasp CLI globally.

```bash
npm i -g @wasp.sh/wasp-cli@latest
```

```bash
npm i -g @wasp.sh/wasp-cli@0.25
```

--------------------------------

### Install Tailwind plugins

Source: https://wasp.sh/docs/guides/libraries/tailwind

Install additional Tailwind plugins via npm as required by their documentation.

```bash
npm install -D @tailwindcss/forms  
npm install -D @tailwindcss/typography  
```

--------------------------------

### Deploy the application

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly

Pushes the built client and server to Fly.io.

```bash
wasp deploy fly deploy
```

--------------------------------

### Install Tailwind CSS dependencies

Source: https://wasp.sh/docs/guides/libraries/tailwind

Install the core Tailwind CSS package and the Vite plugin as development dependencies.

```bash
npm install tailwindcss  

npm install -D @tailwindcss/vite  
```

--------------------------------

### Run Database Studio

Source: https://wasp.sh/docs/guides/debugging/db-studio-fly-io

Launch the Prisma Studio interface to browse and edit production data.

```bash
wasp db studio
```

--------------------------------

### Create a database

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly

Provisions a new database for the application.

```bash
wasp deploy fly create-db <region>
```

--------------------------------

### Manual deployment sequence

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/railway

The individual commands that constitute the launch process.

```bash
wasp deploy railway setup <project-name>

wasp deploy railway deploy <project-name>
```

--------------------------------

### AuthUser Object Structure Examples

Source: https://wasp.sh/docs/auth/entities

Examples showing the structure of the AuthUser object when a user has only Google or only Email identity enabled.

```javascript
const user = {  

  // User data  

  id: "cluqs9qyh00007cn73apj4hp7",  

  address: "Some address",  

  

  // Auth methods specific data  

  identities: {  

    email: null,  

    google: {  

      id: "1117XXXX1301972049448",  

    },  

  },  

}  
```

```javascript
const user = {  

  // User data  

  id: "cluqsex9500017cn7i2hwsg17",  

  address: "Some address",  

  

  // Auth methods specific data  

  identities: {  

    email: {  

      id: "user@app.com",  

      isEmailVerified: true,  

      emailVerificationSentAt: "2024-04-08T10:06:02.204Z",  

      passwordResetSentAt: null,  

    },  

    google: null,  

  },  

}  
```

--------------------------------

### Install Rosetta for Apple Silicon

Source: https://wasp.sh/docs/guides/legacy/installer

Install Rosetta to enable running x86 binaries on Mac systems with Apple Silicon chips.

```bash
softwareupdate --install-rosetta  
```

--------------------------------

### Install Wasp Plugin for Claude Code

Source: https://wasp.sh/docs/wasp-ai/coding-agent-plugin

Commands to add the Wasp plugin marketplace and install the plugin within a Claude Code project.

```bash
claude plugin marketplace add wasp-lang/wasp-agent-plugins
```

```bash
claude plugin install wasp@wasp-agent-plugins --scope project
```

--------------------------------

### GET /users

Source: https://wasp.sh/docs/guides/integrations/swagger-ui

Lists users with optional pagination support.

```APIDOC
## GET /users

### Description
List users.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number (default: 1)
- **limit** (integer) - Optional - Items per page (default: 10)

### Response
#### Success Response (200)
- List of users
```

--------------------------------

### Create Heroku App and Database

Source: https://wasp.sh/docs/guides/deployment/cloud-providers/heroku

Initialize a new Heroku application and provision a PostgreSQL database instance.

```bash
heroku create <app-name>
```

```bash
heroku addons:create --app <app-name> heroku-postgresql:essential-0
```

--------------------------------

### Run build with environment files

Source: https://wasp.sh/docs/deployment/local-testing

Specify environment files for both server and client during local build testing.

```bash
wasp build start --server-env-file .env.staging --client-env-file .env.client.staging
```

--------------------------------

### Update Package List

Source: https://wasp.sh/docs/guides/deployment/self-hosted/vps

Refresh the local package index before installing software.

```bash
apt update
```

--------------------------------

### Initialize and Manage Wasp Plugin

Source: https://wasp.sh/docs/wasp-ai/coding-agent-plugin

Commands to initialize the plugin, start the development server, and view help documentation within an agent session.

```text
Run the '/wasp-plugin-init' skill.
```

```text
Run the 'start-dev-server' skill.
```

```text
/wasp-plugin-help
```

--------------------------------

### GET /users/{id}

Source: https://wasp.sh/docs/guides/integrations/swagger-ui

Retrieves details for a specific user by their unique ID.

```APIDOC
## GET /users/{id}

### Description
Get user by ID.

### Method
GET

### Endpoint
/users/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - User ID

### Response
#### Success Response (200)
- User found

#### Error Response (404)
- User not found
```

--------------------------------

### Set Up Application Providers

Source: https://wasp.sh/docs/project/client-config

Wrap the application with providers in the root component while ensuring the Outlet is rendered.

```TypeScript

import { app } from "@wasp.sh/spec"  

import Root from "./src/Root" with { type: "ref" }  

  

export default app({  

  name: "MyApp",  

  client: {  

    rootComponent: Root,  

  },  

  // ...  

})  



```

```JavaScript

import { Outlet } from "react-router"  

import store from "./store"  

import { Provider } from "react-redux"  

  

export default function Root() {  

  return (  

    <Provider store={store}>  

      <Outlet />  

    </Provider>  

  )  

}  



```

```TypeScript

import { Outlet } from "react-router"  

import store from "./store"  

import { Provider } from "react-redux"  

  

export default function Root() {  

  return (  

    <Provider store={store}>  

      <Outlet />  

    </Provider>  

  )  

}  



```

--------------------------------

### Deploy the client to Netlify

Source: https://wasp.sh/docs/guides/deployment/cloud-providers/netlify

Use the Netlify CLI to deploy the built client, specifying the workspace filter and skipping the build step.

```bash
npx netlify-cli deploy --filter wasp --no-build
```

```bash
npx netlify-cli deploy --prod --filter wasp --no-build
```

--------------------------------

### Implement Queries in JavaScript

Source: https://wasp.sh/docs/data-model/operations/queries

Example implementation of getAllTasks and getFilteredTasks using plain JavaScript.

```javascript
// our "database"  

const tasks = [  

  { id: 1, description: "Buy some eggs", isDone: true },  

  { id: 2, description: "Make an omelette", isDone: false },  

  { id: 3, description: "Eat breakfast", isDone: false },  

]  

  

// You don't need to use the arguments if you don't need them  

export const getAllTasks = () => {  

  return tasks  

}  

  

// The 'args' object is something sent by the caller (most often from the client)  

export const getFilteredTasks = (args) => {  

  const { isDone } = args  

  return tasks.filter((task) => task.isDone === isDone)  

}  
```

--------------------------------

### Define a basic route

Source: https://wasp.sh/docs/api/@wasp.sh/spec/functions/route

A minimal example of defining a route using the route() function.

```typescript
import { page, route } from '@wasp.sh/spec'  

import MainPage from './src/MainPage' with { type: 'ref' }  

  

route('MainRoute', '/', page(MainPage))
```

--------------------------------

### Equivalent commands for launch

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/fly

The launch command performs these three steps sequentially.

```bash
wasp deploy fly setup <app-name> <region>

wasp deploy fly create-db <region>

wasp deploy fly deploy
```

--------------------------------

### Configure netlify.toml

Source: https://wasp.sh/docs/guides/deployment/cloud-providers/netlify

Create a netlify.toml file to define the build output directory and configure SPA redirects.

```toml
[build]
  publish = "./.wasp/out/web-app/build"

# By default, Netlify only redirects when a path doesn't match an existing file.
# See: https://docs.netlify.com/manage/routing/redirects/rewrites-proxies/#shadowing
[[redirects]]
  from = "/*"
  to = "/200.html"
  status = 200
```

--------------------------------

### Install a new dependency

Source: https://wasp.sh/docs/project/dependencies

Use npm to add a new package to your project's dependencies.

```bash
npm install date-fns
```

--------------------------------

### Initialize a new Wasp project

Source: https://wasp.sh/docs/tutorial/create

Creates a new project directory using the minimal template.

```bash
wasp new TodoApp -t minimal
```

--------------------------------

### Run Wasp Install

Source: https://wasp.sh/docs/migration-guide

Command to update Wasp libraries within the project after changing the version.

```bash
wasp install
```

--------------------------------

### Initialize Fly.io App

Source: https://wasp.sh/docs/guides/deployment/cloud-providers/flyio

Launch a new Fly.io application configuration within the build directory.

```bash
fly launch --remote-only
```

--------------------------------

### Deploying with a custom server URL

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/railway

Use the --custom-server-url option to point the client to a specific server domain.

```bash
wasp deploy railway deploy my-wasp-app --custom-server-url https://api.myapp.com  
```

--------------------------------

### Launch a Wasp project on Railway

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/railway

Executes the setup and deployment sequence for a Wasp project on Railway.

```bash
wasp deploy railway launch <project-name>
```

--------------------------------

### Configure main.wasp.ts

Source: https://wasp.sh/docs/guides/integrations/sentry

Register the server and client setup functions within the Wasp configuration file.

```typescript
import { app } from "@wasp.sh/spec"  

import { setupClient } from "./src/clientSetup" with { type: "ref" }  

import { setupServer } from "./src/serverSetup" with { type: "ref" }  

  

export default app({  

  name: "MyApp",  

  wasp: { version: "^0.24.0" },  

  title: "my-app",  

  head: ["<link rel='icon' href='/favicon.ico' />"],  

  server: {  

    setupFn: setupServer,  

  },  

  client: {  

    setupFn: setupClient,  

  },  

  // ...  

})
```

--------------------------------

### Submit a Job for Execution

Source: https://wasp.sh/docs/advanced/jobs

Invoke a job from your operations or setup functions, with optional delay support.

```javascript
import { mySpecialJob } from "wasp/server/jobs"  

  

const submittedJob = await mySpecialJob.submit({ name: "Johnny" })  

  

// Or, if you'd prefer it to execute in the future, just add a .delay().  

// It takes a number of seconds, Date, or ISO date string.  

await mySpecialJob  

  .delay(10)  

  .submit({ name: "Johnny" })
```

```typescript
import { mySpecialJob } from "wasp/server/jobs"  

  

const submittedJob = await mySpecialJob.submit({ name: "Johnny" })  

  

// Or, if you'd prefer it to execute in the future, just add a .delay().  

// It takes a number of seconds, Date, or ISO date string.  

await mySpecialJob  

  .delay(10)  

  .submit({ name: "Johnny" })
```

--------------------------------

### Launch with custom PostgreSQL images

Source: https://wasp.sh/docs/deployment/deployment-methods/wasp-deploy/railway

Specifies a custom Docker image for the PostgreSQL database during the initial launch.

```bash
# Use PostGIS:  

wasp deploy railway launch my-wasp-app --db-image postgis/postgis
```

```bash
# Use pgvector:  

wasp deploy railway launch my-wasp-app --db-image pgvector/pgvector:pg16
```

--------------------------------

### Configure Environment Variables

Source: https://wasp.sh/docs/guides/integrations/custom-oauth

Set up server and client environment variables for OAuth credentials and URLs.

```text
SPOTIFY_CLIENT_ID=your_client_id  

SPOTIFY_CLIENT_SECRET=your_client_secret  

  

# You may need dummy values for built-in providers if you're using them  

# just to get the arctic package installed  

GOOGLE_CLIENT_ID=x  

GOOGLE_CLIENT_SECRET=x  

  

# Spotify rejects `localhost`, so point Wasp at 127.0.0.1 instead  

WASP_SERVER_URL=http://127.0.0.1:3001  

WASP_WEB_CLIENT_URL=http://127.0.0.1:3000  
```

```text
REACT_APP_API_URL=http://127.0.0.1:3001  
```
Tokens:
Raw