{"id":13455476,"url":"https://github.com/elegantframework/elegant-cli","last_synced_at":"2026-01-24T07:07:26.203Z","repository":{"id":142529537,"uuid":"612022247","full_name":"elegantframework/elegant-cli","owner":"elegantframework","description":"✨ Build SEO-friendly websites, super fast full-stack web applications, and much more with Elegant. 💜 Built with Next.js, TipTap, Tailwind CSS, and more.","archived":false,"fork":false,"pushed_at":"2025-02-17T23:49:43.000Z","size":87278,"stargazers_count":200,"open_issues_count":24,"forks_count":21,"subscribers_count":3,"default_branch":"v4.x","last_synced_at":"2025-04-19T15:57:00.198Z","etag":null,"topics":["elegant","jest","markdown","mdx","next","nextjs","outstatic","react","reactjs","storybook","tailwindcss","tiptap","typescript"],"latest_commit_sha":null,"homepage":"https://www.elegantframework.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elegantframework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.MD","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-10T02:59:15.000Z","updated_at":"2025-04-18T10:07:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"c8cffb52-91d3-4bd2-a99a-a3af81179323","html_url":"https://github.com/elegantframework/elegant-cli","commit_stats":{"total_commits":465,"total_committers":8,"mean_commits":58.125,"dds":0.2967741935483871,"last_synced_commit":"d69cef6a1bbad7ff79e9498f03e0ef6346d294c9"},"previous_names":["elegantframework/elegant"],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elegantframework%2Felegant-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elegantframework%2Felegant-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elegantframework%2Felegant-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elegantframework%2Felegant-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elegantframework","download_url":"https://codeload.github.com/elegantframework/elegant-cli/tar.gz/refs/heads/v4.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254527099,"owners_count":22085919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elegant","jest","markdown","mdx","next","nextjs","outstatic","react","reactjs","storybook","tailwindcss","tiptap","typescript"],"created_at":"2024-07-31T08:01:05.941Z","updated_at":"2026-01-24T07:07:26.172Z","avatar_url":"https://github.com/elegantframework.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.elegantframework.com\"\u003e\n    \u003cpicture\u003e\n      \u003cimg src=\"https://github.com/elegantframework/elegant-cli/assets/10189130/742ed0af-bdd7-4d97-83e1-0530f7bed34a\" height=\"200\"\u003e\n    \u003c/picture\u003e\n    \u003ch1 align=\"center\"\u003eElegant\u003c/h1\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/elegant-cli\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/elegant-cli.svg?style=flat\" alt=\"npm version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/elegantframework/elegant/actions\"\u003e\n    \u003cimg src=\"https://github.com/elegantframework/elegant/actions/workflows/install_and_test_elegant_core.yml/badge.svg\" alt=\"Build Status\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/facebook/jest\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/tested_with-jest-99424f.svg\" alt=\"Tested with Jest\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"LICENSE.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/packagist/l/laravel/framework\" alt=\"License\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"CONTRIBUTING.md#pull-requests\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\" alt=\"PRs Welcome\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://discord.gg/PwY38x4uvV\"\u003e\n    \u003cimg src=\"https://img.shields.io/discord/1115406043766329344.svg\" alt=\"Discord Chat\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n**Build SEO-friendly websites, super fast full-stack web applications, and much more with Elegant.**\n\n\n**👩🏻‍💻 Developer Ready**: An all-in-one web application and blogging solution. All the features you need are included right out of the box.\n\n**💰 Simple Hosting**: Deploy your application on the latest and most affordable serverless tech. No need for any complicated server setups or vendor-locked services.\n\n**📰 Data Management**: Seamless integration with PostgreSQL and Prisma, with simplified database management that allows you to focus on building your application. \n\n**🖼️ Content Creation**: Create amazing content with a next-level rich text editor. Perfect for writing blog posts, user guides, and documentation.\n\n**✅ Professional Themes**: Use our professionally crafted themes that are built with Tailwind CSS, or create your own.\n\n**📡 3rd Party Services**: Connect up your favorite services and grow your audience. Analytics services, Newsletter Subscription providers, and more. \n\n---\n\n## Table of Contents\n\n- [What is Elegant?](#what-is-elegant)\n- [Screenshot](#screenshot)\n- [Demo](#demo)\n- [Install](#install)\n- [Configuration](#configuration)\n- [Hosting and Deployments](#deploying)\n- [Creating Content](#creating_content)\n- [Growing Your Audience](#growing_your_audience)\n  - [Analytics](#analytics)\n  - [Newsletter Subscriptions](#newsletter_subscriptions)\n- [Features](#features)\n  - [Database Support](#database_support)\n  - [Sitemaps](#sitemaps)\n  - [Robots.txt](#robots_txt)\n  - [Rich Snippets](#rich_snippets)\n- [Full Documentation](#documentation)\n- [Community](#community)\n- [Contributing](#contributing)\n  - [Feature Suggestions](#feature_suggestions)\n  - [Reporting Issues](#reporting_issues)\n  - [Good First Issues](#good_first_issues)\n- [Stay Up-To-Date](#stay_up_to_date)\n- [License](#license)\n\n## \u003ca name=\"what-is-elegant\"\u003eWhat is Elegant?\u003c/a\u003e\n\nElegant is a community-driven project for building, deploying, and maintaining websites easily. \n\nBuilt with Next.js, Tailwind CSS, TipTap, and more. Elegant is perfect for blogging, documentation websites, or just about any type of web application.\n\n## \u003ca name=\"screenshot\"\u003eScreenshot\u003c/a\u003e\n\n![ezgif-2-2b841a89fd](https://github.com/elegantframework/elegant-cli/assets/10189130/74001fe1-b6ae-46ad-b736-164df13fea22)\n\n## \u003ca name=\"demo\"\u003eDemo\u003c/a\u003e\n\n**With Base Theme**\n\n*Note: The demo below is for Elegant version 3. The demo will be updated with version 4 shortly.*\n\nOnline Demo - Version 3: [https://demo.myelegant.app/](https://demo.myelegant.app/)\n\nAdmin Demo - Version 3: [https://demo.myelegant.app/admin](https://demo.myelegant.app/admin)\n\n## \u003ca name=\"install\"\u003eInstall\u003c/a\u003e\n\nTo get started using Elegant, simply install our CLI tool:\n\n```\nnpm install elegant-cli\n```\n\nNext, run the initialization command to create your website:\n```\nnpx elegant-init\n```\n\nVisit [https://www.elegantframework.com/docs/installation](https://www.elegantframework.com/docs/installation) for the complete installation guide.\n\n## \u003ca name=\"configuration\"\u003eConfiguration\u003c/a\u003e\n\n\n## \u003ca name=\"deploying\"\u003eHosting and Deployments\u003c/a\u003e\n\nDeploying your Elegant application to production is a breeze with Vercel or any other serverless hosting provider.\n\nBecause Elegant is built with the lightweight Next.js framework, your application will run ultra-fast, and at the most affordable monthly hosting costs.\n\nRead the full [Elegant Deployment Guide](https://www.elegantframework.com/docs/deployment).\n\n## \u003ca name=\"creating_content\"\u003eCreating Content\u003c/a\u003e\n\nElegant gives you complete control over your content creation experience with an included content editor for creating and editing documents.\n\n![elegant_content_editor-U4MT](https://github.com/elegantframework/elegant-cli/assets/10189130/a7118506-2a1d-4e60-81e4-9e55edced2df)\n\nThe content editor is where you will write content, add images, and links, and even embed YouTube videos.\n\nRead the complete guide on [Creating Content here](https://www.elegantframework.com/docs/creating-content#writing-content).\n\n## \u003ca name=\"growing_your_audience\"\u003eGrowing Your Audience\u003c/a\u003e\n\nWe have taken care of most of the boilerplate setup code needed to launch the perfect web application so that you can focus on what is important to you.\n\nGrowing your audience is simple with our included native integrations into the most commonly used 3rd party services.\n\n### \u003ca name=\"analytics\"\u003eAnalytics\u003c/a\u003e\n\nTrack your website traffic, and measure your traffic sources to understand which marketing and social channels are most effective.\n\nGoogle Analytics is automatically configured with all new Elegant applications, so you can start tracking your web application user traffic immediately.\n\nTo start using Google Analytics with your Elegant application, simply provide a Google Analytics ID string to the NEXT_PUBLIC_GOOGLE_ANALYTICS_ID environment variable in your .env file.\n\n```\nNEXT_PUBLIC_GOOGLE_ANALYTICS_ID=\"G-4G410MD92K\"\n```\n\n### \u003ca name=\"newsletter_subscriptions\"\u003eNewsletter Subscriptions\u003c/a\u003e\n\nElegant makes it easy to grow your email subscriber lists with included newsletter sign-up templates, and native subscription services.\n\nConvertKit is automatically configured with all new Elegant applications so you may start using it immediately. \n\nIf you are interested in using ConvertKit with your Elegant application, you may simply provide an action URL string to the NEXT_PUBLIC_CONVERTKIT_ACTION_URL environment variable in your .env file.\n\n```\nNEXT_PUBLIC_CONVERTKIT_ACTION_URL=\"https://app.convertkit.com/forms/21224410/subscriptions\"\n```\n\n## \u003ca name=\"features\"\u003eFeatures\u003c/a\u003e\n\n### \u003ca name=\"database_support\"\u003eServerless Database Support\u003c/a\u003e\n\nWith this framework, you can easily integrate your Next.js app with a range of serverless databases, including AWS Aurora Serverless, Google Cloud SQL, Vercel Storage, Neon, and Supabase. By leveraging Prisma and Postgres, you can choose the best storage solution for your needs and enjoy cost-effective, scalable data storage that adapts to your application's demands.\n\n![image](https://github.com/user-attachments/assets/57ad971e-d917-45bd-b9a7-9629119b27a9)\n\n\n### \u003ca name=\"sitemaps\"\u003eSitemaps\u003c/a\u003e\n\nA sitemap is a special file that helps search engines like Google understand the structure of a website. It’s like a map that shows all the pages on a website and how they’re connected to each other.\n\nElegant is configured right out of the box to generate a sitemap.xml file for your web application automatically.\n\nTo learn more, view the complete [Sitemap Guide Here](https://www.elegantframework.com/docs/sitemaps). \n\n### \u003ca name=\"robots_txt\"\u003eRobots.txt\u003c/a\u003e\n\nA robots.txt file is a simple text file that tells search engine crawlers which parts of your web application they are allowed to access and index.\n\nElegant is configured right out of the box to generate a robots.txt for your web application automatically.\n\nBelow is a snippet of our robots.txt for our documentation website.\n\n```\n# *\nUser-agent: *\nAllow: /\n\n# Host\nHost: https://www.elegantframework.com\n\n# Sitemaps\nSitemap: https://www.elegantframework.com/sitemap.xml\n```\n\nTo learn more, view the complete [Robots.txt Guide Here](https://www.elegantframework.com/docs/robots-txt). \n\n### \u003ca name=\"rich_snippets\"\u003eRich Snippets\u003c/a\u003e\n\nRich snippets are a way to provide additional information about a webpage to search engines, like Google, so that they can better understand the content and context of the page. This information can then be displayed in search engine results, making it easier for users to understand what the page is about and whether it’s relevant to their search query.\n\nWe have built Elegant to automatically add the most essential [Rich Snippets](https://www.elegantframework.com/docs/rich-snippets) to your web pages.\n\n## \u003ca name=\"documentation\"\u003eFull Documentation\u003c/a\u003e\n\nYou can find the complete version of the Elegant documentation at [https://elegantframework.com/docs](https://elegantframework.com/docs)\n\n## \u003ca name=\"community\"\u003eCommunity\u003c/a\u003e\n\nThe Elegant community can be found on [GitHub Discussions](https://github.com/orgs/elegantframework/discussions), where you can ask questions, voice ideas, and share your projects.\n\nTo chat with other community members you can join the [Elegant Discord](https://discord.gg/PwY38x4uvV).\n\nOur [Code of Conduct](https://github.com/elegantframework/elegant-cli/blob/v2.3/CODE_OF_CONDUCT.md) applies to all Elegant community channels.\n\n## \u003ca name=\"contributing\"\u003eContributing\u003c/a\u003e\n\nWe've built Elegant because we feel that developers should be more empowered to create better websites and content. We hope that other startups and organizations can benefit from the project. We are thankful for any contributions from the community.\n\nIf you're interested in contributing to the Elegant project, please read our [contributing docs](https://github.com/elegantframework/docs/blob/main/CONTRIBUTING.md) **before submitting a pull request**.\n\n\n### \u003ca name=\"feature_suggestions\"\u003eFeature Suggestions\u003c/a\u003e\n\nElegant is a community-driven project, and open to all suggestions and ideas that help to empower developers everywhere.\n\nVisit our [Feature Request](https://github.com/elegantframework/elegant-cli/issues/new?assignees=\u0026labels=\u0026projects=\u0026template=feature_request.md\u0026title=) page to submit your feedback.\n\n### \u003ca name=\"reporting_issues\"\u003eReporting Issues\u003c/a\u003e\n\nBugs and user friction are our top priority. If you experience any issues or friction during your experience with Elegant, please submit a [Bug Report](https://github.com/elegantframework/elegant-cli/issues/new?assignees=\u0026labels=\u0026projects=\u0026template=bug_report.md\u0026title=).\n\n### \u003ca name=\"good_first_issues\"\u003eGood First Issues\u003c/a\u003e\n\nWe have a list of [good first issues](https://github.com/elegantframework/elegant-cli/labels/good%20first%20issue) that contain bugs and features that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.\n\n\n## \u003ca name=\"stay_up_to_date\"\u003eStay Up-To-Date\u003c/a\u003e\n\nThe Elegant project is constantly evolving and improving daily. You can keep up and show your support by hitting the **Star** button! We appreciate it! 😊\n\n![support-elegant-with-a-star-on-github](https://github.com/elegantframework/elegant-cli/assets/10189130/28132259-174b-43ac-a850-8437298885be)\n\n\n## \u003ca name=\"license\"\u003eLicense\u003c/a\u003e\n\nThe Elegant Framework is open-sourced software licensed under the [MIT license](https://opensource.org/license/mit/).\n","funding_links":[],"categories":["Code Design"],"sub_categories":["Boilerplate"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felegantframework%2Felegant-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felegantframework%2Felegant-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felegantframework%2Felegant-cli/lists"}