diff --git a/README.md b/README.md index 9df2c0f09ea..d651a12f680 100644 --- a/README.md +++ b/README.md @@ -1,107 +1,309 @@ - -
- - -
- Ghost.org •
- Forum •
- Docs •
- Contributing •
- Twitter
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-The easiest way to get a production instance deployed is with our official **[Ghost(Pro)](https://ghost.org/pricing/)** managed service. It takes about 2 minutes to launch a new site with worldwide CDN, backups, security and maintenance all done for you.
-
-For most people this ends up being the best value option because of [how much time it saves](https://ghost.org/docs/hosting/) — and 100% of revenue goes to the Ghost Foundation; funding the maintenance and further development of the project itself. So you’ll be supporting open source software *and* getting a great service!
-
-
-
-# Quickstart install
-
-If you want to run your own instance of Ghost, in most cases the best way is to use our **CLI tool**
+# GhostX
+
+> A modern, customizable publishing platform built on top of Ghost, designed for creators, communities, memberships, newsletters, and digital content.
+
+[](https://github.com/TryGhost/Ghost)
+[](LICENSE)
+[](#project-status)
+
+## 📖 About
+
+**GhostX** is a customized and extended version of the open-source [Ghost](https://github.com/TryGhost/Ghost) publishing platform.
+
+The project aims to build a flexible and modern publishing ecosystem while preserving Ghost's powerful publishing capabilities and introducing additional features for creators, communities, publishers, and digital content platforms.
+
+GhostX is currently under active development.
+
+## ✨ Features
+
+* 📝 Powerful content publishing
+* 👤 User and member accounts
+* 📧 Newsletter support
+* 💳 Memberships and subscriptions
+* 🔒 Members-only content
+* 🎨 Customizable themes and interfaces
+* 🔌 API-driven architecture
+* 📚 Digital content publishing
+* ⚡ High-performance publishing infrastructure
+* 🛠️ Extensible architecture
+* 🔐 Security-focused development
+* 📊 Analytics and content management capabilities
+
+## 🏗️ Technology
+
+GhostX is based on the Ghost codebase and its existing technology stack.
+
+Key technologies include:
+
+* **Node.js**
+* **JavaScript / TypeScript**
+* **React**
+* **Ember.js**
+* **Express**
+* **MySQL**
+* **Redis**
+* **pnpm**
+* **Nx**
+
+> GhostX follows the upstream Ghost development workflow and currently uses **pnpm** as its package manager.
+
+## 📂 Project Structure
+
+```text
+GhostX/
+├── apps/ # Application packages
+├── configs/ # Shared configuration
+├── docker/ # Docker configuration
+├── docs/ # Documentation
+├── e2e/ # End-to-end tests
+├── ghost/
+│ └── core/ # Ghost Core
+├── koenig/ # Editor-related packages
+├── packages/ # Shared packages and libraries
+├── scripts/ # Development and build scripts
+├── .github/ # GitHub workflows and configuration
+├── package.json # Root package configuration
+├── pnpm-workspace.yaml # pnpm workspace configuration
+└── README.md # Project documentation
+```
+
+> The project structure may change as GhostX evolves.
+
+## 🚀 Getting Started
+
+### Prerequisites
+
+Before developing GhostX, make sure you have the required tools installed:
+* [Node.js](https://nodejs.org/)
+* [pnpm](https://pnpm.io/)
+* Git
+* MySQL
+* Redis
+* Docker *(optional)*
+
+### Clone the Repository
+
+```bash
+git clone https://github.com/YOUR_USERNAME/GhostX.git
+cd GhostX
```
-npm install ghost-cli -g
+
+### Initialize pnpm
+
+For a fresh checkout:
+
+```bash
+pnpm setup
```
-
+Restart your terminal if required so that pnpm becomes available.
-Then, if installing locally add the `local` flag to get up and running in under a minute - [Local install docs](https://ghost.org/docs/install/local/)
+### Install Dependencies
+```bash
+pnpm install
```
-ghost install local
+
+### Start Development
+
+Use the development commands defined by the current GhostX codebase:
+
+```bash
+pnpm dev
```
-
+For the complete development workflow, consult the project's development documentation.
+
+## ⚙️ Environment Configuration
+
+GhostX may require environment variables for local development and production.
-or on a server run the full install, including automatic SSL setup using LetsEncrypt - [Production install docs](https://ghost.org/docs/install/ubuntu/)
+If the repository provides an environment template, copy it before starting development:
+```bash
+cp .env.example .env
```
-ghost install
+
+Configure the required values in `.env`.
+
+### 🔐 Important
+
+**Never commit secrets to GitHub.**
+
+Do not commit:
+
+* API keys
+* Database passwords
+* Authentication secrets
+* Private tokens
+* Cloud credentials
+* Encryption keys
+* Production environment variables
+
+Make sure sensitive files are included in `.gitignore`.
+
+## 🧪 Testing
+
+Run the project's standard validation checks with:
+
+```bash
+pnpm check
+```
+
+Additional tests may be available for individual applications and packages.
+
+For example:
+
+```bash
+pnpm test
```
-
+Refer to the relevant package documentation before running specialized tests.
+
+## 🐳 Docker
+
+Docker can be used for local development and infrastructure services.
+
+Start the development environment with the appropriate Compose configuration:
+
+```bash
+docker compose up
+```
+
+For production deployment, use the project's production documentation and configuration rather than the development Compose setup.
+
+## 🗺️ Roadmap
+
+GhostX is evolving continuously.
+
+### Planned Features
+
+* [ ] Modernized user experience
+* [ ] Enhanced creator profiles
+* [ ] Community functionality
+* [ ] Advanced content discovery
+* [ ] Improved analytics
+* [ ] Additional membership tools
+* [ ] Digital content marketplace
+* [ ] Creator monetization features
+* [ ] Enhanced administration tools
+* [ ] Performance improvements
+* [ ] Security hardening
+* [ ] Mobile-focused improvements
+* [ ] Developer APIs and integrations
+* [ ] Additional customization options
+
+## 🔐 Security
+
+Security is a core priority of GhostX.
+
+If you discover a security vulnerability, **do not publicly disclose it through GitHub Issues**.
+
+Please report security issues privately through the appropriate security reporting process.
+
+See [SECURITY.md](SECURITY.md) for additional information.
+
+## 🤝 Contributing
+
+Contributions are welcome.
+
+### 1. Fork GhostX
+
+Create your own fork of the GhostX repository.
+
+### 2. Clone Your Fork
+
+```bash
+git clone https://github.com/YOUR_USERNAME/GhostX.git
+cd GhostX
+```
+
+### 3. Create a Branch
+
+```bash
+git checkout -b feature/my-feature
+```
+
+### 4. Make Your Changes
+
+Implement your changes while following the project's coding and contribution guidelines.
+
+### 5. Validate Your Changes
+
+```bash
+pnpm check
+```
+
+Run any additional tests required for the area you modified.
+
+### 6. Commit Your Changes
+
+```bash
+git add .
+git commit -m "feat: add my feature"
+```
+
+### 7. Push Your Branch
+
+```bash
+git push origin feature/my-feature
+```
+
+### 8. Open a Pull Request
+
+Open a Pull Request on GitHub and explain:
+
+* What you changed
+* Why you changed it
+* How you tested it
+* Any relevant screenshots or documentation
+
+## 📜 License
+
+GhostX is derived from the open-source [Ghost](https://github.com/TryGhost/Ghost) project.
+
+The upstream Ghost project is released under the **MIT License**. Ghost and the Ghost logo are trademarks of the Ghost Foundation.
+
+GhostX must retain and comply with the applicable licenses, copyright notices, and trademark requirements of the upstream project and its dependencies.
+
+See [LICENSE](LICENSE) for the applicable license information.
-Check out our [official documentation](https://ghost.org/docs/) for more information about our [recommended hosting stack](https://ghost.org/docs/hosting/) & properly [upgrading Ghost](https://ghost.org/docs/update/), plus everything you need to develop your own Ghost [themes](https://ghost.org/docs/themes/) or work with [our API](https://ghost.org/docs/content-api/).
+## 🙏 Acknowledgements
-### Contributors & advanced developers
+GhostX is built upon the work of the Ghost Foundation and the Ghost open-source community.
-To contribute to Ghost, start with the
-[contributing guide](.github/CONTRIBUTING.md). To work on the monorepo, see the
-[codebase documentation](docs/README.md).
+Special thanks to the developers and contributors behind:
-
+* [Ghost](https://github.com/TryGhost/Ghost)
+* Node.js
+* React
+* Ember.js
+* Express
+* MySQL
+* Redis
+* Nx
+* pnpm
-# Ghost sponsors
+## 📌 Project Status
-A big thanks to our sponsors and partners who make Ghost possible. If you're interested in sponsoring Ghost and supporting the project, please check out our profile on [GitHub sponsors](https://github.com/sponsors/TryGhost) :heart:
+**🚧 Active Development**
-**[DigitalOcean](https://m.do.co/c/9ff29836d717)** • **[Fastly](https://www.fastly.com/)** • **[Tinybird](https://tbrd.co/ghost)** • **[BairesDev](https://www.bairesdev.com)**
+GhostX is currently being customized and developed.
-
+Features, APIs, architecture, and project structure may change as development progresses.
-# Getting help
+This project should be considered experimental until a stable release is announced.
-Everyone can get help and support from a large community of developers over on the [Ghost forum](https://forum.ghost.org/). **Ghost(Pro)** customers have access to 24/7 email support.
+## 🌐 Links
-To stay up to date with all the latest news and product updates, make sure you [subscribe to our changelog newsletter](https://ghost.org/changelog/) — or follow us [on Twitter](https://twitter.com/Ghost), if you prefer your updates bite-sized and facetious. :saxophone::turtle:
+* **GhostX:** `https://github.com/evilhere7/GhostX`
+* **Original Ghost Repository:** `https://github.com/TryGhost/Ghost`
+* **Ghost Website:** `https://ghost.org`
+* **Ghost Documentation:** `https://ghost.org/docs/`
-
+---
-# License & trademark
+⭐ **If you find GhostX useful, consider starring the repository and contributing to the project.**
-Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE).
-Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our [trademark policy](https://ghost.org/trademark/) for info on acceptable usage.
+**Built with ❤️ by the GhostX community.**