Replace default Laravel README with project-specific docs
Document what Muninn does (content-operations hub for Sites, Social Accounts, and Posts with a JSON API for AI agents) and how to set it up locally. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
m105
@@ -1,58 +1,104 @@
|
||||
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
|
||||
# Muninn
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
|
||||
</p>
|
||||
Muninn is a personal content-operations hub. It keeps track of your
|
||||
**Sites**, **Social Accounts**, and **Posts**, and exposes them over a
|
||||
local JSON API so an AI agent (or you, via the built-in UI) can draft,
|
||||
schedule, and publish content across WordPress blogs, Reddit, and other
|
||||
platforms.
|
||||
|
||||
## About Laravel
|
||||
Built with Laravel 13, Livewire, and Tailwind CSS.
|
||||
|
||||
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
|
||||
## What it does
|
||||
|
||||
- [Simple, fast routing engine](https://laravel.com/docs/routing).
|
||||
- [Powerful dependency injection container](https://laravel.com/docs/container).
|
||||
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
|
||||
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
|
||||
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
|
||||
- [Robust background job processing](https://laravel.com/docs/queues).
|
||||
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
|
||||
- **Sites** — the websites you own (WordPress, custom, or other), with
|
||||
optional WordPress Application Password credentials for publishing.
|
||||
- **Social Accounts** — logins for social networks (Twitter, Instagram,
|
||||
Facebook, Reddit, TikTok, LinkedIn, YouTube, etc.).
|
||||
- **Posts** — the actual content, each tied to a Site and optionally a
|
||||
Social Account, moving through `draft -> scheduled -> published/failed`.
|
||||
- A **JSON API** (`/api/sites`, `/api/accounts`, `/api/posts`) plus thin
|
||||
Python CLI wrappers in `python_scripts/`, so an agent can poll for due
|
||||
posts (`?due=1`) and drive the publish lifecycle without hand-rolling
|
||||
HTTP requests.
|
||||
- Built-in publishing paths:
|
||||
- **WordPress**: `php artisan posts:publish {post_id}` posts directly to
|
||||
a site's WordPress REST API and updates the post's status.
|
||||
- **Reddit**: a standalone Playwright sidecar at
|
||||
`sidecars/reddit-post/` logs in and creates a post.
|
||||
- Anything else: publish however fits, then report back via the API.
|
||||
|
||||
Laravel is accessible, powerful, and provides tools required for large, robust applications.
|
||||
See `AI_API.md` for the full API reference and publishing contract, and
|
||||
`python_scripts/README.md` for the CLI wrapper usage.
|
||||
|
||||
## Learning Laravel
|
||||
**Note:** the JSON API has no authentication and returns credentials in
|
||||
plain text by design — it's meant to run on your local network only, not
|
||||
be exposed to the public internet.
|
||||
|
||||
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
|
||||
## Requirements
|
||||
|
||||
In addition, [Laracasts](https://laracasts.com) contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
|
||||
- PHP 8.3+
|
||||
- Composer
|
||||
- Node.js + npm
|
||||
- MySQL (or another Laravel-supported database)
|
||||
|
||||
You can also watch bite-sized lessons with real-world projects on [Laravel Learn](https://laravel.com/learn), where you will be guided through building a Laravel application from scratch while learning PHP fundamentals.
|
||||
|
||||
## Agentic Development
|
||||
|
||||
Laravel's predictable structure and conventions make it ideal for AI coding agents like Claude Code, Cursor, and GitHub Copilot. Install [Laravel Boost](https://laravel.com/docs/ai) to supercharge your AI workflow:
|
||||
## Setup
|
||||
|
||||
```bash
|
||||
composer require laravel/boost --dev
|
||||
|
||||
php artisan boost:install
|
||||
composer install
|
||||
cp .env.example .env
|
||||
php artisan key:generate
|
||||
```
|
||||
|
||||
Boost provides your agent 15+ tools and skills that help agents build Laravel applications while following best practices.
|
||||
Edit `.env` and set your database credentials (`DB_DATABASE`,
|
||||
`DB_USERNAME`, `DB_PASSWORD`, etc. — defaults assume a local MySQL
|
||||
database named `muninn`), then run migrations:
|
||||
|
||||
## Contributing
|
||||
```bash
|
||||
php artisan migrate
|
||||
```
|
||||
|
||||
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
||||
Install JS dependencies and build frontend assets:
|
||||
|
||||
## Code of Conduct
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
|
||||
Alternatively, run everything in one shot with:
|
||||
|
||||
## Security Vulnerabilities
|
||||
```bash
|
||||
composer run setup
|
||||
```
|
||||
|
||||
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
|
||||
### Running locally
|
||||
|
||||
```bash
|
||||
composer run dev
|
||||
```
|
||||
|
||||
This starts the PHP dev server, queue listener, log viewer (Pail), and
|
||||
Vite dev server together. The app is served at `http://localhost:8000` by
|
||||
default.
|
||||
|
||||
### Reddit sidecar (optional)
|
||||
|
||||
If you plan to publish to Reddit, set up the Playwright sidecar separately:
|
||||
|
||||
```bash
|
||||
cd sidecars/reddit-post
|
||||
npm install
|
||||
npx playwright install
|
||||
```
|
||||
|
||||
See `sidecars/reddit-post/README.md` for usage.
|
||||
|
||||
## Testing
|
||||
|
||||
```bash
|
||||
composer test
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
The Laravel framework is open-sourced software licensed under the
|
||||
[MIT license](https://opensource.org/licenses/MIT).
|
||||
|
||||
Reference in New Issue
Block a user