|
1 |
| - |
2 |
| -[](https://chat.apostrophecms.org) |
3 |
| - |
4 |
| -<p align="center"> |
| 1 | +<div align="center"> |
5 | 2 | <a href="https://github.com/apostrophecms/apostrophe">
|
6 | 3 | <img src="logo.svg" alt="ApostropheCMS logo" width="80" height="80">
|
7 | 4 | </a>
|
8 | 5 |
|
9 |
| - <h3 align="center">ApostropheCMS 3</h3> |
| 6 | + <h1>ApostropheCMS</h1> |
| 7 | + |
| 8 | + <p> |
| 9 | + <a aria-label="Join the community on Discord" href="http://chat.apostrophecms.org"> |
| 10 | + <img alt="" src="https://img.shields.io/discord/517772094482677790?color=5865f2&label=Join%20the%20Discord&logo=discord&logoColor=fff&labelColor=000&style=for-the-badge&logoWidth=20" /> |
| 11 | + </a> |
| 12 | + <a aria-label="License" href="https://github.com/apostrophecms/apostrophe/blob/main/LICENSE.md"> |
| 13 | + <img alt="" src="https://img.shields.io/static/v1?style=for-the-badge&labelColor=000000&label=License&message=MIT&color=3DA639" /> |
| 14 | + </a> |
| 15 | + </p> |
10 | 16 |
|
11 |
| - <p align="center"> |
12 |
| - ApostropheCMS is a full-featured, open source CMS built with Node.js that seeks to empower organizations by combining in-context editing and headless architecture in a full-stack JS environment. |
| 17 | + <p> |
| 18 | + <strong>Full-stack CMS for developers and content teams</strong><br /> |
| 19 | + Build websites with in-context editing and headless flexibility using Node.js and MongoDB. |
13 | 20 | <br />
|
14 |
| - <a href="https://v3.docs.apostrophecms.org/"><strong>Documentation »</strong></a> |
| 21 | + <a href="https://docs.apostrophecms.org/"><strong>Documentation »</strong></a> |
15 | 22 | <br />
|
16 | 23 | <br />
|
17 | 24 | <a href="http://demo.apostrophecms.com">Demo</a>
|
18 | 25 | ·
|
19 |
| - <a href="https://portal.productboard.com/apostrophecms/1-product-roadmap/tabs/2-planned">Roadmap</a> |
| 26 | + <a href="https://productlane.com/edit-roadmap">Roadmap</a> |
20 | 27 | ·
|
21 | 28 | <a href="https://github.com/apostrophecms/apostrophe/issues/new?assignees=&labels=bug,3.0&template=bug_report.md&title=">Report Bug</a>
|
22 | 29 | </p>
|
23 |
| -</p> |
| 30 | +</div> |
| 31 | + |
| 32 | +## About |
| 33 | + |
| 34 | +ApostropheCMS is a full-stack content management system built with Node.js and MongoDB. Content creators can edit directly on live pages without switching between admin interfaces, while developers can build with modern JavaScript or use it headlessly with any frontend framework. |
| 35 | + |
| 36 | +### Key Features |
| 37 | + |
| 38 | +- **🎯 In-Context Editing** - Content creators edit directly on the live page, seeing changes instantly |
| 39 | +- **⚡ Headless-Ready** - Use any frontend framework while keeping the powerful admin experience |
| 40 | +- **🛠️ Developer-First** - Built with Node.js and MongoDB for full-stack JavaScript development |
| 41 | +- **📈 Scales Beautifully** - From small sites to enterprise applications handling millions of pages |
| 42 | +- **🔐 Enterprise Features** - Advanced permissions, workflow management, automated translations, and more |
| 43 | + |
| 44 | +## System Requirements |
| 45 | + |
| 46 | +| Requirement | Version | Installation Notes | |
| 47 | +|-------------|---------|-------------------| |
| 48 | +| **Node.js** | 20.x+ | Use [NVM](https://github.com/nvm-sh/nvm) for version management | |
| 49 | +| **MongoDB** | 6.0+ | [MongoDB Atlas](https://www.mongodb.com/atlas) (cloud) or local install | |
| 50 | +| **npm** | 10.x+ | Included with Node.js | |
| 51 | + |
| 52 | +See our [setup guides](https://docs.apostrophecms.org/guide/development-setup.html) for installation instructions. |
| 53 | + |
| 54 | +## Quick Start |
| 55 | + |
| 56 | +Get ApostropheCMS running locally in minutes: |
| 57 | + |
| 58 | +```bash |
| 59 | +# Option 1: Install CLI globally (recommended for multiple projects) |
| 60 | +npm install -g @apostrophecms/cli |
| 61 | +apos create my-website |
| 62 | +cd my-website |
| 63 | +npm run dev |
| 64 | + |
| 65 | +# Option 2: Use npx for one-time project creation |
| 66 | +npx @apostrophecms/cli create my-website |
| 67 | +cd my-website |
| 68 | +npm run dev |
| 69 | +``` |
24 | 70 |
|
25 |
| -## About ApostropheCMS |
| 71 | +Your new ApostropheCMS site will be available at `http://localhost:3000` with a powerful admin interface at `/login`. |
26 | 72 |
|
27 |
| -ApostropheCMS is content software for everyone in an organization. It helps teams of all sizes create dynamic digital experiences with elegance and efficiency by blending powerful features, developer happiness, and a low learning curve for content creators. Apostrophe has powered websites and web apps for organizations large and small for over a decade. |
| 73 | +### Prefer to Go Headless? |
28 | 74 |
|
29 |
| -#### Built With |
| 75 | +**Get started with Astro integration** - the easiest way to build headless sites while keeping visual editing: |
30 | 76 |
|
31 |
| -* [Node](https://nodejs.org/en/) |
32 |
| -* [MongoDB](https://www.mongodb.com/) |
33 |
| -* [Nunjucks](https://mozilla.github.io/nunjucks/) |
| 77 | +- **[Apollo Starter Kit (Astro)](https://apostrophecms.com/starter-kits/apollo-starter-kit-for-astro-cms)** - Production-ready foundation with beautiful design system and rich content features |
| 78 | +- **[Essentials Starter Kit (Astro)](git clone https://github.com/apostrophecms/starter-kit-astro-essentials)** - Minimal, clean foundation for building custom designs from scratch |
34 | 79 |
|
35 |
| -## Getting Started |
| 80 | +Both starter kits provide headless CMS power with in-context editing, letting content creators edit directly on the live site while you build with modern frontend tools. Our Astro integration handles all the content fetching automatically—no REST API calls to write. |
36 | 81 |
|
37 |
| -To get started with Apostrophe 3, follow these steps to set up a local development environment. For more detail, refer to the [A3 getting started guide](https://a3.docs.apostrophecms.org/guide/setting-up.html) in the documentation. |
| 82 | +**Desire a different frontend framework?** Use our REST APIs with React, Vue, Svelte, or any other framework: |
38 | 83 |
|
39 |
| -#### Prerequisites |
| 84 | +- **[REST API Documentation](https://docs.apostrophecms.org/reference/api/pieces.html)** - Complete API reference |
| 85 | +- **[Headless CMS Guide](https://docs.apostrophecms.org/guide/headless-cms.html)** - Integration walkthrough for any framework |
40 | 86 |
|
41 |
| -We recommend installing the following with [Homebrew](https://brew.sh/) on macOS. If you're on Linux, you should use your package manager (apt or yum). If you're on Windows, we recommend the Windows Subsystem for Linux. |
| 87 | +### Hosting & Deployment |
42 | 88 |
|
43 |
| -| Software | Minimum Version | Notes |
44 |
| -| ------------- | ------------- | ----- |
45 |
| -| Node.js | 12.x | Or better |
46 |
| -| npm | 6.x | Or better |
47 |
| -| MongoDB | 3.6 | Or better |
48 |
| -| Imagemagick | Any | Faster image uploads, GIF support (optional) |
| 89 | +Choose [ApostropheCMS hosting](https://apostrophecms.com/hosting) for turnkey solutions with optimized performance and dedicated support, or deploy to [any platform where Node.js runs](https://docs.apostrophecms.org/guide/hosting.html). |
49 | 90 |
|
50 |
| -## Community |
| 91 | +## Built With Modern Tech |
51 | 92 |
|
52 |
| -[Discord](https://discord.com/invite/XkbRNq7) - [Twitter](https://twitter.com/apostrophecms) - [Discussions](https://github.com/apostrophecms/apostrophe/discussions) |
| 93 | +- **[Node.js](https://nodejs.org/)** - JavaScript runtime for server-side development |
| 94 | +- **[MongoDB](https://www.mongodb.com/)** - Flexible document database for content storage |
| 95 | +- **ESM Modules** - Native ES6 module support for modern JavaScript |
| 96 | +- **Vite** - Lightning-fast build tool and development server |
| 97 | +- **Modern JavaScript** - ES6+, async/await, and contemporary development patterns |
| 98 | + |
| 99 | +## Community & Support |
| 100 | + |
| 101 | +**Join other developers and content creators using ApostropheCMS:** |
| 102 | + |
| 103 | +- **[Discord](https://discord.com/invite/XkbRNq7)** - Get help, share projects, and connect with other users |
| 104 | +- **[GitHub Discussions](https://github.com/apostrophecms/apostrophe/discussions)** - Feature requests, technical discussions, and community support |
| 105 | +- **[Documentation](https://docs.apostrophecms.org/)** - Comprehensive guides, tutorials, and API references |
53 | 106 |
|
54 | 107 | ## Contributing
|
55 | 108 |
|
56 |
| -We eagerly welcome open source contributions. Before submitting a PR, please read through our [Contribution Guide](https://github.com/apostrophecms/apostrophe/blob/main/CONTRIBUTING.md) |
| 109 | +We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help makes ApostropheCMS better for everyone. |
| 110 | + |
| 111 | +- **[Contribution Guide](https://github.com/apostrophecms/apostrophe/blob/main/CONTRIBUTING.md)** - How to contribute code, documentation, and feedback |
| 112 | +- **[Good First Issues](https://github.com/apostrophecms/apostrophe/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)** - Perfect starting points for new contributors |
| 113 | + |
| 114 | + |
| 115 | +## Pro Features |
| 116 | + |
| 117 | +**For teams and organizations requiring additional features:** |
| 118 | + |
| 119 | +- **🔐 Advanced User Management** - Granular permissions, user groups, and access controls |
| 120 | +- **🌍 Automated Translation** - AI-powered translation with DeepL, Google Translate, and Azure |
| 121 | +- **📊 Analytics & SEO** - Built-in SEO optimization and content analytics |
| 122 | +- **⚡ Performance Optimization** - Advanced caching, CDN integration, and performance monitoring |
| 123 | +- **🏢 Multisite Management** - Manage multiple sites from a single dashboard with shared resources |
| 124 | +- **💼 Professional Support** - Dedicated support, training, and consultation services |
| 125 | + |
| 126 | +[Explore all the pro extensions](https://apostrophecms.com/extensions?autocomplete=&license=assembly&license=pro) and [sign up](https://app.apostrophecms.com/login) for a Pro license in our self-service Apostrophe Workspaces, or [contact us](https://apostrophecms.com/contact-us) to learn about licensing and support options. |
57 | 127 |
|
58 | 128 | ## License
|
59 | 129 |
|
60 |
| -ApostropheCMS is released under the [ MIT License](https://github.com/apostrophecms/apostrophe/blob/main/LICENSE.md). |
| 130 | +ApostropheCMS is open source software licensed under the [MIT License](https://github.com/apostrophecms/apostrophe/blob/main/LICENSE.md). This means you're free to use, modify, and distribute it for both personal and commercial projects. |
| 131 | + |
| 132 | +--- |
| 133 | + |
| 134 | +<div align="center"> |
| 135 | + <p> |
| 136 | + <strong>Ready to build something amazing?</strong><br> |
| 137 | + <a href="https://docs.apostrophecms.org/">Get started with our documentation</a> or <a href="https://apostrophecms.com/contact-us">talk to our team</a> |
| 138 | + </p> |
| 139 | + <p> |
| 140 | + <em>Built with ❤️ by the <a href="https://apostrophecms.com">ApostropheCMS team</a></em> |
| 141 | + </p> |
| 142 | +</div> |
0 commit comments