Skip to content

Latest commit

ย 

History

History
77 lines (47 loc) ยท 1.51 KB

File metadata and controls

77 lines (47 loc) ยท 1.51 KB

๐ŸŒค๏ธ FriendlyLog

Human-friendly summaries of AWS CloudWatch metrics, logs, and alerts โ€” without needing to be a cloud engineer.


๐Ÿง  What It Does

FriendlyLog helps non-technical users (or busy devs) understand their AWS application health at a glance.

  • ๐Ÿฆš Prettified Logs The Cloudwatch UI is ugly. Friendlylog, less so.
  • ๐Ÿ“Š Summarized trends in key logs & alerts - coming soon
  • ๐Ÿ’ก Plain language insights like โ€œErrors spiked 40% after your last deploymentโ€ - coming soon

๐Ÿš€ Getting Started

1. Clone the repo

git clone https://github.com/PersonOfNote/friendlyLog.git
cd friendlyLog

2. Install dependencies

npm install

3. Set up environment variables

Create a .env file in the root directory with the following variables:

NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-supabase-anon-key
AWS_ACCESS_KEY_ID=your-aws-access-key-id
AWS_SECRET_ACCESS_KEY=your-aws-secret-access-key
AWS_REGION=your-aws-region
AWS_ROLE_ARN=your-aws-role-arn

4. Run the app

npm run dev

๐Ÿ“ฆ Tech Stack Next.js โ€“ SSR-friendly React framework

Supabase โ€“ Auth + DB

AWS SDK v3 โ€“ Programmatic CloudWatch access

๐Ÿ“Œ Roadmap Basic Supabase auth flow โœ…

AWS integration wizard/onboarding โœ…

Pretty logs โœ…

Daily summary email โœ…

Subscription implementation

Graphs

Plain-language alerts and rule setting

๐Ÿง‘โ€๐Ÿ’ป Contributing

File issues or feature requests under the Issues tab.