From b473bbb31ec10160cfff33b881fa5eaa8fa8765c Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 22 May 2026 21:27:10 +0000 Subject: [PATCH] docs: improve README.md with detailed project information - Added comprehensive project description and key features. - Documented tech stack including Astro, Next.js, and Drizzle. - Added project structure map for monorepo. - Improved getting started and installation guides. - Detailed environment variables and deployment instructions. Co-authored-by: coldhell7 <3526356+coldhell7@users.noreply.github.com> --- README.md | 124 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 103 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 786aced..fda9485 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,118 @@ -# Medalino — Fastest CMS +# Medalino — Fastest AI-Powered CMS -Fastest CMS with all of the WordPress features + SEO friendly +Medalino is a modern, lightweight, and blazing-fast CMS designed to provide all the power of WordPress with a focus on SEO, performance, and AI-assisted content creation. -Medalino is a lightweight, fast CMS designed to provide the features site owners expect from WordPress while remaining SEO-first and performance-focused. +Built with a modern monorepo architecture, Medalino separates the concerns of content management and delivery, ensuring your storefront remains incredibly fast while providing a rich, responsive admin experience. -Quick highlights -- Fast server-side rendering and small client bundle sizes -- Built-in admin panel and content CMS -- SEO-friendly markup and JSON-LD support -- Easy deploy with Nginx + Let's Encrypt +## 🚀 Key Features -Quickstart (development) +- **⚡ Blazing Fast Performance:** High-performance storefront powered by Astro and server-side rendering. +- **🤖 AI-Powered Content:** Integrated Google Gemini support for generating SEO-optimized posts, product descriptions, and metadata. +- **🔍 SEO-First Architecture:** Built-in JSON-LD support, SEO-friendly markup, and automatic sitemap generation. +- **🎨 Modern Tech Stack:** Next.js 15+ (Admin), Astro 6+ (Storefront), Tailwind CSS 4, and React 19. +- **📦 Monorepo Structure:** Efficiently managed with Turbo and pnpm for shared logic and components. +- **💾 Robust Data Layer:** Drizzle ORM with Postgres support and Upstash Redis for caching/rate-limiting. +- **🛠️ Easy Deployment:** Pre-configured Nginx and systemd service configurations for seamless production setup. +## 🛠️ Tech Stack + +- **Frameworks:** [Astro](https://astro.build/) (Storefront), [Next.js](https://nextjs.org/) (Admin) +- **Styling:** [Tailwind CSS 4](https://tailwindcss.com/) +- **Database:** [Drizzle ORM](https://orm.drizzle.team/), [Postgres](https://www.postgresql.org/) +- **AI:** [Google Gemini API](https://ai.google.dev/) +- **Caching:** [Upstash Redis](https://upstash.com/) +- **Monorepo:** [Turbo](https://turbo.build/), [pnpm](https://pnpm.io/) + +## 📂 Project Structure + +```text +. +├── apps/ +│ ├── admin/ # Next.js admin dashboard with AI content generation +│ └── storefront/ # Astro-powered high-performance public website +├── packages/ +│ ├── cms/ # Content storage and CMS logic (JSON-based) +│ ├── database/ # Drizzle ORM schemas and database client +│ ├── shared/ # Shared Zod schemas and utility functions +│ └── ui/ # Reusable React components and CSS tokens +├── deploy/ # Nginx and systemd configuration files +└── scripts/ # Helper scripts for maintenance and deployment +``` + +## 🚥 Getting Started + +### Prerequisites + +- [Node.js](https://nodejs.org/) (>= 22.12.0) +- [pnpm](https://pnpm.io/) (>= 10.x) + +### Installation + +1. Clone the repository: + ```bash + git clone https://github.com/your-username/medalino.git + cd medalino + ``` + +2. Install dependencies: + ```bash + pnpm install + ``` + +3. Setup environment variables (see [Environment Variables](#-environment-variables)). + +### Development + +Run the entire project in development mode: ```bash -# install dependencies -pnpm install +pnpm dev +``` -# run storefront and admin (monorepo) +Or run specific applications: +```bash pnpm --filter storefront dev pnpm --filter admin dev ``` -Production (server) +### Database Management + +```bash +# Generate migrations +pnpm db:generate + +# Push changes to database +pnpm db:push +``` + +## ⚙️ Environment Variables + +Create a `.env` file in the root or specifically within `apps/admin` and `apps/storefront`. + +| Variable | Description | Location | +|----------|-------------|----------| +| `DATABASE_URL` | Postgres connection string | root/admin | +| `GEMINI_API_KEY` | Google Gemini API Key for AI features | admin | +| `UPSTASH_REDIS_REST_URL` | Upstash Redis URL for caching | admin | +| `UPSTASH_REDIS_REST_TOKEN` | Upstash Redis Token | admin | +| `PUBLIC_ADMIN_URL` | URL of the admin panel | storefront/admin | +| `PUBLIC_SITE_URL` | URL of the public storefront | storefront/admin | +| `ADMIN_AUTH_SECRET` | Secret for session tokens | admin | + +## 🚢 Deployment + +1. **Build the project:** + ```bash + pnpm build + ``` -1. Build the monorepo: `pnpm --filter admin build` -2. Run the admin on port `3002` and proxy via Nginx at `https://admin.medalino.ir` +2. **Server Setup:** + The `deploy/` directory contains sample Nginx and systemd configurations. + - Use `medalino-admin.service` for managing the Next.js admin process. + - Configure Nginx using `nginx-admin.conf` and `nginx-medalino.conf`. -Environment variables -- `ADMIN_AUTH_SECRET` — long secret used to sign session tokens -- `PUBLIC_ADMIN_URL` — e.g. `https://admin.medalino.ir` -- `PUBLIC_SITE_URL` — e.g. `https://medalino.ir` +3. **Static Generation:** + The storefront is built using Astro and can be deployed as static files or using a Node.js adapter depending on your configuration. -License +## 📄 License -MIT +This project is licensed under the MIT License.