add readme

Author: florianbgt

.env.example

@@ -1,12 +1,20 @@
-STRIPE_API_KEY=
-WEBHOOK_SECRET=
-STRIPE_METER_CREDIT_USAGE_METER_ID=
-STRIPE_PRODUCT_BASIC_LICENSE_MONTHLY_PRICE_ID=
-STRIPE_PRODUCT_BASIC_LICENSE_YEARLY_PRICE_ID=
-STRIPE_PRODUCT_BASIC_MONTHLY_METER_CREDIT_USAGE_PRICE_ID=
-STRIPE_PRODUCT_PRO_LICENSE_MONTHLY_PRICE_ID=
-STRIPE_PRODUCT_PRO_LICENSE_YEARLY_PRICE_ID=
-STRIPE_PRODUCT_PRO_MONTHLY_METER_CREDIT_USAGE_PRICE_ID=
-STRIPE_PRODUCT_PREMIUM_LICENSE_MONTHLY_PRICE_ID=
-STRIPE_PRODUCT_PREMIUM_LICENSE_YEARLY_PRICE_ID=
-STRIPE_PRODUCT_PREMIUM_MONTHLY_METER_CREDIT_USAGE_PRICE_ID=
+# Stripe Configuration
+# Get these from your Stripe Dashboard: https://dashboard.stripe.com/apikeys
+STRIPE_API_KEY=sk_test_your_stripe_secret_key_here
+STRIPE_WEBHOOK_SECRET=whsec_your_webhook_secret_here
+
+# Stripe Product and Price IDs
+# Create these in your Stripe Dashboard under Products & Prices
+# You can use the convinience script in /packages/core/src/stripe/scripts/createObjects.ts
+# To generate these if you start from a fresh stripe account
+STRIPE_METER_CREDIT_USAGE_METER_ID=price_your_meter_credit_price_id_here
+STRIPE_PRODUCT_BASIC_MONTHLY_PRICE_ID=price_basic_monthly_price_id_here
+STRIPE_PRODUCT_PRO_MONTHLY_PRICE_ID=price_pro_monthly_price_id_here
+STRIPE_PRODUCT_PRO_YEARLY_PRICE_ID=price_pro_yearly_price_id_here
+STRIPE_PRODUCT_PREMIUM_MONTHLY_PRICE_ID=price_premium_monthly_price_id_here
+STRIPE_PRODUCT_PREMIUM_YEARLY_PRICE_ID=price_premium_yearly_price_id_here
+
+# Development/Testing Flags, for convenience
+SKIP_OTP=true
+EMAIL_USE_CONSOLE=true
+GCP_USE_FAKE_GCS_SERVER=true

README.md

@@ -0,0 +1,80 @@
+# StackCore
+
+A code dependency analysis and visualization platform that helps developers
+understand, audit, and optimize their codebase architecture through interactive
+visualizations and automated analysis.
+
+## 🚀 Quick Start
+
+### Prerequisites
+
+- [Deno](https://deno.land/) v2.3.5+
+- [Docker](https://docker.com)
+
+### Setup for local devlopment
+
+1. **Setup Stripe objects**
+
+   Create a Stripe account and set up the required Stripe objects (products,
+   prices, and meters). You can use the convenience script at
+   [packages/core/src/stripe/scripts/createObjects.ts](packages/core/src/stripe/scripts/createObjects.ts).
+
+   Run the script and follow the prompts - it will create all the necessary
+   objects and output their IDs which you'll need for the next step.
+
+1. **Create `.env` file**
+
+   Copy `.env.example` content into a `.env` file and fill in the missing
+   variables.
+
+1. **Start services**
+
+   ```bash
+   # database
+   deno task db:docker
+   deno task db:migrate
+
+   # Terminal 1: stripe CLI to forward webhook to the API
+   deno task stripe:forward
+
+   # Terminal 2: Fake gcs bucket
+   deno task bucket:mock
+
+   # Terminal 3: API
+   deno task dev:core
+
+   # Terminal 4: APP
+   deno task dev:app
+   ```
+
+### Unit test
+
+Before running the test, you need:
+
+```bash
+# mock stripe API
+deno task stripe:mock
+
+# mock gcs bucker
+deno task bucket:mock
+
+# then run the test
+deno task test
+```
+
+## 📊 What StackCore Does
+
+- **Dependency Visualization**: Interactive graphs showing file and symbol-level
+  dependencies
+- **Code Metrics**: Cyclomatic complexity, line counts, dependency analysis
+- **Audit Reports**: Automated detection of code quality issues
+- **Multi-level Analysis**: Project, file, and symbol-level insights
+
+### Architecture
+
+- **`@stackcore/core`**: Backend API (Deno + Oak)
+- **`@stackcore/app`**: Frontend (React + Cytoscape.js)
+
+## 📝 License
+
+[Add your license information here]