---
icon: flag-checkered
---

# Getting Started

## Prerequisites

* PHP (v8.2 or higher)
* Composer
* Node.js (v22 or higher)
* MySQL/SQLite/Postgres or any compatible database
* Basic understanding of Laravel and Vue.js

## Installation

```bash
composer create-project circlexo/circlexo my-project
```

update your environment variables in `.env` file

```
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=circlexo
DB_USERNAME=root
DB_PASSWORD=

# Discord Bot / Notifications Options
DISCORD_CLIENT_ID=
DISCORD_CLIENT_SECRET=
DISCORD_URL=
DISCORD_WEBHOOK=
DISCORD_ERROR_WEBHOOK=
DISCORD_OTP_WEBHOOK=
DISCORD_ERROR_WEBHOOK_ACTIVE=true
DISCORD_APPLICATION_ID=
DISCORD_PUBLIC_KEY=
DISCORD_BOT_TOKEN=
DISCORD_REPORTS_WEBHOOK=
DISCORD_JIRA_WEBHOOK=

# Github Services Connect
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
GITHUB_URL=
GITHUB_USERNAME=
GITHUB_TOKEN=

# Google Services Connect
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
GOOGLE_CALLBACK=
GOOGLE_CREDENTIALS=

# Google Analytics
ANALYTICS_PROPERTY_ID=
ANALYTICS_CREDENTIALS=

# Jira Services Connect
JIRA_APP_ID=
JIRA_REDIRECT_URI=
JIRA_CLIENT_ID=
JIRA_CLIENT_SECRET=
JIRA_USERNAME=
JIRA_PROJECT_KEY=
JIRA_HOST=
JIRA_EMAIL=
JIRA_TOKEN=
JIRA_BOARD=

# Stripe Services Connect
STRIPE_SECRET=

# RevenueCat Services Connect
REVENUE_CAT_API_KEY=
REVENUE_CAT_PROJECT_ID=

# OpenAI Services Connect
OPENAI_API_KEY=
OPENAI_ASSISTANT_ID=
OPENAI_ORGANIZATION=

# VAPOR Services Connect
VAPOR_API_KEY=
VAPOR_TEAM_ID=

# Webhook Secret
WEBHOOK_SECRET=
```

now you need to build your frontend

```bash
php artisan filament:assets
php artisan livewire:publish --assets
npm i
npm run build
```

it's time for data

```bash
php artisan migrate
php artisan db:seed
php artisan optimize
composer dev
```