Skip to content

Commit 3c42cc8

Browse files
authored
Merge branch 'main' into perplexity-flutter
2 parents 74e3d4e + 181019c commit 3c42cc8

File tree

5 files changed

+1986
-0
lines changed

5 files changed

+1986
-0
lines changed

.github/workflows/pr-validation.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: MDX Validation
2+
3+
on:
4+
pull_request:
5+
branches: [ main ]
6+
paths:
7+
- 'docs/**'
8+
- '.github/workflows/**'
9+
10+
jobs:
11+
mdx-validation:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout repo
15+
uses: actions/checkout@v4
16+
17+
- name: Setup Node.js
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: '18'
21+
cache: 'npm'
22+
23+
- name: MDX validation dependencies
24+
run: npm install --save-dev @mdx-js/mdx @mdx-js/loader glob
25+
26+
- name: Validate MDX files
27+
run: node scripts/validate-mdx.js
28+
29+
- name: Check for broken links
30+
run: |
31+
# Simple check for common broken link patterns
32+
echo "Checking for potential broken links..."
33+
if grep -r "http://localhost\|http://127.0.0.1" docs/; then
34+
echo "❌ Found localhost links that should be removed"
35+
exit 1
36+
fi
37+
echo "✅ No obvious broken links found"
38+
39+
- name: Validate frontmatter
40+
run: |
41+
# Check that all MDX files have required frontmatter
42+
find docs -name "*.mdx" -type f | while read file; do
43+
if ! head -n 10 "$file" | grep -q "^---$"; then
44+
echo "❌ $file - Missing frontmatter (no --- markers)"
45+
exit 1
46+
fi
47+
echo "✅ $file - Has frontmatter"
48+
done

docs/showcase/briefo.mdx

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Briefo | Perplexity Powered News & Finance Social App
3+
description: AI curated newsfeed, social discussion, and deep research reports built on the Sonar API
4+
sidebar_position: 1
5+
keywords: [Briefo, finance, news, social media, React Native, Supabase]
6+
---
7+
8+
# Briefo | Perplexity Powered News & Finance Social App
9+
10+
**Briefo** delivers a personalized, AI generated newsfeed and company deep dives. Readers can follow breaking stories, request on demand financial analyses, and discuss insights with friends, all in one mobile experience powered by Perplexity’s Sonar API.
11+
12+
## Features
13+
14+
* Personalized newsfeed across 17 categories with AI summaries and source links
15+
* Private and public threads for article discussion and sharing
16+
* Watch list with real time market snapshots and optional AI analyses
17+
* Deep research reports generated on 12 selectable criteria such as management, competitors, and valuation
18+
* General purpose chat assistant that remembers each user’s preferred topics
19+
20+
## Prerequisites
21+
22+
* Node 18 LTS or newer
23+
* npm, Yarn, or pnpm
24+
* Expo CLI (`npm i -g expo-cli`)
25+
* Supabase CLI 1.0 or newer for local emulation and Edge Function deploys
26+
27+
## Installation
28+
29+
git clone https://github.com/adamblackman/briefo-public.git
30+
cd briefo-public
31+
npm install
32+
### Environment variables
33+
34+
# .env (project root)
35+
MY_SUPABASE_URL=https://<project>.supabase.co
36+
MY_SUPABASE_SERVICE_ROLE_KEY=...
37+
PERPLEXITY_API_KEY=...
38+
LINKPREVIEW_API_KEY=...
39+
ALPACA_API_KEY=...
40+
ALPACA_SECRET_KEY=...
41+
42+
# .env.local (inside supabase/)
43+
# duplicate or override any secrets needed by Edge Functions
44+
45+
## Usage
46+
Run the Expo development server:
47+
48+
npx expo start
49+
50+
Deploy Edge Functions when you are ready:
51+
52+
supabase functions deploy perplexity-news perplexity-chat perplexity-research portfolio-tab-data
53+
54+
## Code Explanation
55+
56+
* Frontend: React Native with Expo Router (TypeScript) targeting iOS, Android, and Web
57+
* Backend: Supabase (PostgreSQL, Row Level Security, Realtime) for data and authentication
58+
* Edge Functions: TypeScript on Deno calling Perplexity, Alpaca, Alpha Vantage, and LinkPreview APIs
59+
* Hooks: Reusable React Query style data hooks live in lib/ and hooks/
60+
* Testing and Linting: ESLint, Prettier, and Expo Lint maintain code quality
61+
62+
## Links
63+
https://github.com/adamblackman/briefo-public
64+
https://www.briefo.fun/

0 commit comments

Comments
 (0)