Locus

https://docs.paywithlocus.com
Admin
Locus is a payment infrastructure platform that enables AI agents to autonomously send and manage...
Tokens:1,236
Snippets:10
Trust Score:3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Run Locus Application after Setup

Source: https://docs.paywithlocus.com/getting-started

Instructions to navigate into the newly created Locus project directory and start the application using npm. Assumes the project has been successfully initialized and dependencies installed.

```bash
cd my-locus-app
npm start
```

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

### Example Project Structure of a Locus App

Source: https://docs.paywithlocus.com/getting-started

Illustrates the typical file and directory structure generated for a Locus application. Highlights key files such as index.js, package.json, .env, and README.md.

```text
my-locus-app/
├── index.js           # Main application file
├── package.json       # Dependencies and scripts
├── .env              # Your credentials (DO NOT COMMIT)
├── .env.example      # Example environment variables
├── .gitignore        # Git ignore rules
└── README.md         # Project documentation
```

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

### Create New Locus Application using npm

Source: https://docs.paywithlocus.com/getting-started

Provides commands to initialize a new Locus application using npm. It shows how to create an app with a default name or specify a custom project name, leveraging the @locus-technologies/locus-app package.

```bash
npm create @locus-technologies/locus-app
```

```bash
npm create @locus-technologies/locus-app my-locus-app
```

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

### Securely Store Locus Credentials in .env File

Source: https://docs.paywithlocus.com/getting-started

Demonstrates how to configure environment variables for Locus authentication (OAuth or API Key) and Anthropic API key within a .env file. This is crucial for securely managing sensitive credentials and preventing them from being committed to version control.

```bash
# For OAuth (LangChain)
LOCUS_CLIENT_ID=your_client_id_here
LOCUS_CLIENT_SECRET=your_client_secret_here

# For API Key (AI SDK)
LOCUS_API_KEY=your_api_key_here

# Anthropic API Key (required for both)
ANTHROPIC_API_KEY=your_anthropic_key_here
```
Tokens:
Raw