Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.
C# aspnet-corecsharpdockerdotnetecommerceecommerce-platformmongodbmulti-storemulti-vendornosqlonline-shopshoppingcart
Make the repository easier to find: README, docs and community files (#869)
Krzysztof Pajakf273f6a806f3
diff --git a/.github/FUNDING.yml b/.github/FUNDING.ymlnew file mode 100644index 000000000..b6530d0a7--- /dev/null+++ b/.github/FUNDING.yml@@ -0,0 +1 @@+open_collective: grandnodediff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.ymlnew file mode 100644index 000000000..2272f7e89--- /dev/null+++ b/.github/ISSUE_TEMPLATE/bug_report.yml@@ -0,0 +1,72 @@+name: Bug report+description: Something in GrandNode does not work as it should.+labels: ["bug"]+body:+ - type: markdown+ attributes:+ value: |+ Thanks for taking the time to report a bug. Please search the [existing issues](https://github.com/grandnode/grandnode2/issues) first.+ Security vulnerabilities go through the [private reporting form](https://github.com/grandnode/grandnode2/security/advisories/new), not here.+ - type: textarea+ id: description+ attributes:+ label: What happened+ description: What you saw, and what you expected to see instead.+ validations:+ required: true+ - type: textarea+ id: steps+ attributes:+ label: Steps to reproduce+ description: Numbered steps someone else can follow on a fresh installation or on the demo.+ placeholder: |+ 1. Go to ...+ 2. Click ...+ 3. See the error+ validations:+ required: true+ - type: input+ id: version+ attributes:+ label: GrandNode version+ description: A release number (for example 2.3.0), or the branch and commit you run.+ validations:+ required: true+ - type: dropdown+ id: area+ attributes:+ label: Where does it happen+ multiple: true+ options:+ - Storefront+ - Admin panel+ - Store owner panel+ - Vendor panel+ - REST API+ - Installation or upgrade+ - Plugin or theme+ - Other+ validations:+ required: true+ - type: dropdown+ id: hosting+ attributes:+ label: How do you run GrandNode+ options:+ - Docker+ - Linux+ - Windows / IIS+ - Kubernetes or cloud service+ - Locally from an IDE+ - Other+ - type: input+ id: database+ attributes:+ label: Database+ description: For example MongoDB 7.0, MongoDB Atlas, Azure Cosmos DB, LiteDB.+ - type: textarea+ id: logs+ attributes:+ label: Logs and screenshots+ description: Error messages, stack traces from the admin system log or the console, screenshots.+ render: textdiff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.ymlnew file mode 100644index 000000000..1b4812b93--- /dev/null+++ b/.github/ISSUE_TEMPLATE/config.yml@@ -0,0 +1,11 @@+blank_issues_enabled: false+contact_links:+ - name: Question or idea+ url: https://github.com/grandnode/grandnode2/discussions+ about: Ask how to do something, share an idea or show what you built with GrandNode.+ - name: Security vulnerability+ url: https://github.com/grandnode/grandnode2/security/advisories/new+ about: Report a vulnerability privately. Please do not open a public issue.+ - name: Premium support+ url: https://grandnode.com/premium-support-packages/?utm_source=github&utm_medium=link&utm_campaign=issue-template+ about: Commercial help with installation, upgrades and custom development.diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.ymlnew file mode 100644index 000000000..711cbc89e--- /dev/null+++ b/.github/ISSUE_TEMPLATE/feature_request.yml@@ -0,0 +1,33 @@+name: Feature request+description: Suggest a new feature or an improvement to an existing one.+labels: ["enhancement"]+body:+ - type: markdown+ attributes:+ value: |+ Open ideas and early-stage proposals are welcome in [Discussions](https://github.com/grandnode/grandnode2/discussions) as well.+ - type: textarea+ id: problem+ attributes:+ label: The problem+ description: What you are trying to do and what stops you today.+ validations:+ required: true+ - type: textarea+ id: solution+ attributes:+ label: Proposed solution+ description: How you would like GrandNode to handle it.+ validations:+ required: true+ - type: textarea+ id: alternatives+ attributes:+ label: Alternatives considered+ description: Workarounds you use now, plugins you tried, how other platforms solve it.+ - type: checkboxes+ id: contribution+ attributes:+ label: Contribution+ options:+ - label: I would like to submit a pull request for this.diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 9b34b9783..a2a8f5e60 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -16,4 +16,6 @@ To start with us, you should do this few steps:And that's all, you are GrandNode official contributor!-[Coding standards and guides](http://docs.grandnode.com/developers-guide)+How to build and run the code locally: [docs/development.md](docs/development.md)++[Coding standards and guides](https://docs.grandnode.com/developers-guide)diff --git a/README.md b/README.mdindex cd2f598ae..e493882ec 100644--- a/README.md+++ b/README.md@@ -1,111 +1,105 @@<p align="center">- <a href="https://grandnode.com/">- <img src="https://grandnode.com/logo.png" alt="GrandNode - Open Source E-Commerce Platform">+ <a href="https://grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme">+ <img src="https://grandnode.com/logo.png" alt="GrandNode - open-source e-commerce platform for ASP.NET Core and MongoDB"></a>+</p>++<h1 align="center">GrandNode - open-source e-commerce platform for .NET</h1>- <h1 align="center">OPEN-SOURCE E-COMMERCE PLATFORM- <br />- FREE, FAST, FLEXIBLE, FEATURE-RICH</h1>- <p align="center">- GrandNode is a powerful, scalable e-Commerce platform built with MongoDB and ASP.NET Core. <br />-Based on the modern MongoDB database, this fully open-source system supports multiple business models: <br />- B2B, B2C, Multi-Store, Multi-Vendor, Multi-Tenant, Multi-Language, Multi-Currency. <br />-Achieve superior performance, unlimited scalability, and comprehensive customization to drive your online business success.- </p>- <p align="center">- <a href="https://grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme"><strong>Explore the project »</strong></a>- <br />- <br />- <a href="https://demo.grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme">View Demo</a>- ·- <a href="https://github.com/grandnode/grandnode2/issues">Report Bug</a>- ·- <a href="https://github.com/grandnode/grandnode2/issues">Request Feature</a>- ·- <a href="https://grandnode.com/boards/?utm_source=github&utm_medium=link&utm_campaign=readme">Visit forum</a>- ·- <a href="https://grandnode.com/grandnode-themes/?utm_source=github&utm_medium=link&utm_campaign=readme">Themes</a>- ·- <a href="https://grandnode.com/extensions/?utm_source=github&utm_medium=link&utm_campaign=readme">Integrations & Plugins</a>- ·- <a href="https://grandnode.com/premium-support-packages/?utm_source=github&utm_medium=link&utm_campaign=readme">Premium support</a>- </p>+<p align="center">+ <strong>Free, fast and feature-rich online store software built with ASP.NET Core 10 and MongoDB.</strong><br />+ Multi-store, multi-vendor marketplace, B2B and B2C, multi-language and multi-currency - in one self-hosted application.</p>++<p align="center">+ <a href="https://demo.grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme"><strong>Live demo</strong></a>+ ·+ <a href="https://grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme">Website</a>+ ·+ <a href="https://docs.grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme">Documentation</a>+ ·+ <a href="https://github.com/grandnode/grandnode2/discussions">Discussions</a>+ ·+ <a href="https://grandnode.com/grandnode-themes/?utm_source=github&utm_medium=link&utm_campaign=readme">Themes</a>+ ·+ <a href="https://grandnode.com/extensions/?utm_source=github&utm_medium=link&utm_campaign=readme">Integrations & plugins</a>+ ·+ <a href="https://grandnode.com/premium-support-packages/?utm_source=github&utm_medium=link&utm_campaign=readme">Premium support</a>+</p>+<div align="center">--[](https://dev.azure.com/grandnode/grandnode2/_build/latest?definitionId=8&branchName=develop)+[](https://github.com/grandnode/grandnode2/releases)+[](https://hub.docker.com/r/grandnode/grandnode2)+[](https://github.com/grandnode/grandnode2/stargazers)+[](LICENSE)+<br />+[](https://github.com/grandnode/grandnode2/actions/workflows/aspnetcore.yml)[](https://github.com/grandnode/grandnode2/actions/workflows/docker-image.yml)-[](https://github.com/grandnode/grandnode2/actions/workflows/codeql.yml)+</div>-<!-- TABLE OF CONTENTS -->## Table of Contents-* [Overview](#Overview)-* [Key Features](#key-features)-* [Technical Highlights](#technical-highlights)-* [Getting Started](#getting-started)- * [Prerequisites](#prerequisites)- * [Installation](#installation)- * [Building from source](#building-from-source)- * [Running locally](#running-locally)- * [Online demo](#online-demo)-* [Roadmap](#roadmap)+* [What is GrandNode?](#what-is-grandnode)+* [Key features](#key-features)+* [Technology stack](#technology-stack)+* [Quick start](#quick-start)+* [Online demo](#online-demo)+* [Documentation](#documentation)+* [Community and support](#community-and-support)* [Contributing](#contributing)* [Sponsors](#sponsors)-* [Why Choose GrandNode?](#why-choose-grandnode)* [License](#license)+## What is GrandNode?-## Overview--GrandNode was designed to solve the most important business challenges from the world of digital shopping. The goal for us is to provide the platform with:-* The high performance front-end, rendered within miliseconds,-* The high performance application to handle temporary and permanent traffic overloads,-* Highly advanced e-commerce platform with unlimited possibilities of integration with existing third-party softwares-* Fast development with modern codebase-* Scalable e-commerce platform to grow with the business+GrandNode is a free, open-source **e-commerce platform written in C# on ASP.NET Core**, with **MongoDB** as its+database. It runs a single online shop just as well as a multi-store installation or a **multi-vendor+marketplace**, serves **B2B and B2C** customers from the same catalog, and exposes a **REST API** for headless+storefronts, mobile apps and integrations with ERP, PIM and CRM systems.-## Key Features+It is built for developers and agencies on .NET who need a shopping cart they can host anywhere - on Linux,+Windows, in Docker or Kubernetes - and extend with plugins and themes, without per-store licence fees.-### Performance & Architecture-- ⚡ **High-Performance** - Pages render in milliseconds-- 📊 **MongoDB Database** - Superior scalability and performance-- 🚀 **ASP.NET Core** - Modern and efficient codebase+## Key features-### Business Features-- 🏪 **Multi-Store Management** - Run multiple stores from one installation-- 👥 **B2B & B2C Support** - Serve both business and consumer customers-- 🌎 **Multi-Language & Multi-Currency** - Sell globally with localized experiences-- 🛒 **Advanced Product Catalog** - Flexible product attributes, variants, and pricing-- 💰 **Multiple Payment Gateways** - Including Stripe, BrainTree and more-- 🚚 **Customizable Shipping Options** - Fixed rate, by weight, shipping points-- 📱 **Mobile-Optimized** - Responsive design for all devices+### Selling+- 🏪 **Multi-store** - run many storefronts, domains and catalogs from one installation, with a separate store owner panel+- 🤝 **Multi-vendor marketplace** - vendors manage their own products and orders in a dedicated vendor panel+- 👥 **B2B and B2C** - customer groups, tier prices, sales employees+- 🌎 **Multi-language and multi-currency** - localized content, right-to-left support, automatic exchange rates+- 🛒 **Advanced product catalog** - product attributes and combinations, bundles, grouped products, downloadable products, reservations and auctions+- 💳 **Payments** - Stripe Checkout, Braintree, cash on delivery and more through plugins+- 🚚 **Shipping** - fixed rate, by weight, pickup points+- 🧾 **Taxes** - fixed rate or by country, state and zip code-### Marketing & SEO-- 🔍 **SEO-Friendly** - URL structure, meta tags, and sitemap generation-- 🔔 **Customer Segmentation** - Target specific customer groups-- 📧 **Email Marketing Integration** - Boost your sales with newsletters-- 📊 **Analytics Integration** - Track performance with Google Analytics+### Marketing and SEO+- 🔍 **SEO-friendly** - clean URLs, meta tags, canonical URLs, XML sitemaps and schema.org JSON-LD with price, availability, rating, shipping and return policy+- 🏷️ **Discounts and promotions** - coupon codes, discount rules, loyalty points, gift vouchers+- 🎯 **Customer segmentation** - target customer groups and tags with content, prices and discounts+- 📧 **Newsletters and messaging** - message templates, campaigns, push notifications+- 📊 **Analytics** - Google Analytics and Facebook Pixel integrations-## Technical Highlights+### Look and feel+- 🎨 **Themes** - Default, Modern and Nordic Editorial storefront themes included, with per-store theme selection+- 📱 **Responsive** - Vue 3 and Bootstrap 5 storefront that works on every device+- 🧩 **Content** - CMS pages, blog, news, sliders and widget zones-GrandNode 2 leverages the latest technologies to deliver a high-performance e-commerce solution:+## Technology stack-- **ASP.NET Core 10.0** - Modern, cross-platform framework-- **MongoDB 4.0+** - NoSQL database for unlimited scalability-- **Vue 3 + Bootstrap 5** - Storefront UI, bundled with Vite-- **Docker Support** - Easy deployment and containerization-- **REST API** - Comprehensive API for integrations-- **Cloud-Ready** - Optimized for cloud hosting environments-- **Real-time Processing** - Immediate updates throughout the system--<!-- GETTING STARTED -->-## Getting Started+| Area | Technology |+| --- | --- |+| Backend | **ASP.NET Core 10**, C# |+| Database | **MongoDB 4.0+** (also Azure Cosmos DB and Amazon DocumentDB through the MongoDB API, LiteDB for small installs) |+| Storefront | **Vue 3**, Bootstrap 5, bundled with Vite |+| Admin panels | Bootstrap 5, Tabulator grids - Admin, Store owner and Vendor panels |+| API | REST backend and frontend API with OpenAPI |+| Deployment | **Docker** images on Docker Hub and GHCR, Linux, Windows, Kubernetes-ready |+| Extensibility | Plugins (payments, shipping, tax, widgets, authentication, discount rules), themes, modules |-To get a local copy up and running follow these simple steps.+## Quick start### Prerequisites@@ -116,256 +110,75 @@ To get a local copy up and running follow these simple steps.| [Node.js](https://nodejs.org/) + npm | **22 LTS** (22.22+) or **24 LTS** (24.15+); the admin panel tests need it, the builds alone run on 20.19+ | only when you change the storefront or admin panel frontend sources. The build output is committed, so you can run the shop without Node || IDE | any with .NET 10 support - Visual Studio, JetBrains Rider, VS Code | optional |-Only the SDK and MongoDB are required to get the shop running - see-[Building from source](#building-from-source) for when Node.js comes into play.+The `develop` branch is the development version and may be unstable; `main` holds the latest stable version.+Stable versions are also on the [Releases](https://github.com/grandnode/grandnode2/releases) page.-### Installation+### Run with Docker-GrandNode can be installed in a few different ways. Note: The develop branch is the development version of GrandNode and it may be unstable. The main branch is the primary branch that contains the latest stable version. You can also download specific stable versions from the Releases page or switch to a release branch.--* Docker```bash-docker run -d -p 127.0.0.1:27017:27017 --name mongodb mongo+docker run -d -p 127.0.0.1:27017:27017 --name mongodb mongodocker run -d -p 80:8080 --name grandnode2 --link mongodb:mongo -v grandnode_images:/app/wwwroot/assets/images -v grandnode_appdata:/app/App_Data grandnode/grandnode2-```-If you want to download the latest stable version of GrandNode please use the following command, where x.xx is a number of GrandNode release:-```bash-docker pull grandnode/grandnode2:x.xx-```--#### Running more than one instance--Files GrandNode writes at runtime (sitemap XML files, custom CSS/JS, uploaded images, thumbnails, the push-service worker) live in `wwwroot` by default, so with several instances each one only sees its own. Point-`Application:MediaPath` at a volume shared by all instances (ReadWriteMany in Kubernetes: Azure Files, EFS, NFS):--```bash-docker run -d -p 80:8080 --name grandnode2 --link mongodb:mongo \- -e Application__MediaPath=/app/media -v grandnode_media:/app/media \- -v grandnode_appdata:/app/App_Data grandnode/grandnode2```-Files that ship with the build stay in `wwwroot` and are used until the shop overwrites them. When switching an-existing installation, **move** (not copy) `wwwroot/assets/custom`, `wwwroot/assets/images/uploaded`,-`wwwroot/sitemap*.xml`, `wwwroot/firebase-messaging-sw.js` and, with pictures stored on disk, the-`wwwroot/assets/images/*_0.*` originals into the same paths under the media path, then stop mounting the old-`wwwroot/assets/images` volume. With the `Directory` setting configured, both sides carry it as a prefix: move-`wwwroot/{Directory}/assets/custom` to `{MediaPath}/{Directory}/assets/custom`, and so on. Without the move, each-instance serves its own copy of the sitemap until the sitemap task runs again, and of the push service worker until-the push notification settings are saved again. A file left behind in `wwwroot` keeps being served after it is-deleted in the admin, because the shop only deletes on the media path. Thumbnails are regenerated on the media path.--* Open locally in an IDE--Extract the source code package downloaded from the Releases tab to a folder (or-clone the repository), and open `GrandNode.slnx`. Build the whole solution - that-compiles the modules and plugins into the web project's output as well - then set-`Grand.Web` as the startup project and run it. See-[Building from source](#building-from-source) for the command line equivalent and-for the frontend build.+Open <http://localhost>, and the installer asks for the MongoDB connection string (`mongodb://mongo/grandnode`+with the commands above) and the administrator account.-* Host on Linux server+### Run from source-Before you start - please install, configure the nginx server, the .NET 10 SDK and MongoDB 4.0+-```bash-mkdir ~/source-cd ~/source-git clone - b x.xx https://github.com/grandnode/grandnode2.git-```-```bash-cd ~/source/grandnode-dotnet restore GrandNode.slnx-```-Now it's time to rebuild all modules and plugins and publish the application. Each-module and plugin copies itself into the web project's output, so they have to be-built *before* the publish step:-```bash-for module in src/Modules/*; do dotnet build "$module" -c Release; done-for plugin in src/Plugins/*; do dotnet build "$plugin" -c Release; done-dotnet publish src/Web/Grand.Web -c Release -o /var/webapps/grandnode-```-Optional: Create the service file, to automatically restart your application.```bash-sudo vi /etc/systemd/system/grandnode.service-```-Paste the following content, and save changes:-```ini-[Unit]-Description=GrandNode--[Service]-WorkingDirectory=/var/webapps/grandnode-ExecStart=/usr/bin/dotnet /var/webapps/grandnode/Grand.Web.dll-Restart=always-RestartSec=10-SyslogIdentifier=dotnet-grandnode-User=www-data-Environment=ASPNETCORE_ENVIRONMENT=Production--[Install]-WantedBy=multi-user.target-```-Enable the service and restart the GrandNode-```-sudo systemctl enable grandnode.service-sudo systemctl start grandnode.service-```-Feel free to visit our [detailed guide about GrandNode installation.](https://grandnode.com/how-to-install-grandnode-on-linux-ubuntu-1604/?utm_source=github&utm_medium=link&utm_campaign=readme)--### Building from source--#### Backend--```bash-dotnet restore GrandNode.slnx+git clone https://github.com/grandnode/grandnode2.git+cd grandnode2dotnet build GrandNode.slnx-```--`GrandNode.slnx` contains the whole application: the core libraries, the web-project, the modules under `src/Modules` (installer, migrations, REST API,-scheduled tasks) and the plugins under `src/Plugins`. Building the solution-builds them all and copies each module and plugin into-`src/Web/Grand.Web/Modules` / `Plugins`, so a plain `dotnet build` is enough.--Two things worth knowing:--* **Plugins that ship views compile those views into the plugin DLL.** After- editing a `.cshtml` file in, for example, `src/Plugins/Theme.Modern`, rebuild- that plugin (`dotnet build src/Plugins/Theme.Modern`) - the running site will- not pick the change up otherwise. Razor runtime compilation covers only- `Grand.Web`'s own views. Stop the site before rebuilding a plugin, or the- build fails on a locked DLL.-* Building a plugin on its own is fine and is what the Docker image does; you- only need the full solution build after changing shared code.--#### Frontend--The repository has two npm projects: the storefront (below) and the Admin, Store-and Vendor panels (at the end of this section).--The storefront UI (Vue 3, Bootstrap 5) lives in `src/Web/Grand.Web/vueapp`:--```bash-cd src/Web/Grand.Web/vueapp-npm install-npm run build-```--That writes into `src/Web/Grand.Web/wwwroot/bundles`:--| output | contents |-| --- | --- |-| `app.runtime.bundle.js` | Vue 3, the compatibility layer, the per-page view-models and the shared DOM behaviours |-| `libs.css` | Bootstrap, Bootstrap Icons, animate.css, Pikaday |-| `style.min.css`, `style.rtl.min.css` | the theme stylesheets from `wwwroot/theme/css`, concatenated in cascade order and minified |--**This output is committed to the repository**, which is why neither the CI-workflows nor the Dockerfile install Node - they build the .NET solution against-the bundles already in the tree. The flip side is that when you change anything-under `vueapp/src` or `wwwroot/theme/css` you have to run `npm run build` and-commit the regenerated bundles together with the source change, otherwise your-change simply will not be on the page.--Other scripts: `npm run dev` (watch build), `npm run lint` (ESLint over-`vueapp/src`), `npm run audit:prod`. More detail in-[`vueapp/README.md`](src/Web/Grand.Web/vueapp/README.md).--The Admin, Store and Vendor panels (Bootstrap 5, the Tabulator-based-`<admin-grid>`, vanilla JS widgets) are built by-`src/Web/Grand.SharedUIResources/adminapp`:--```bash-cd src/Web/Grand.SharedUIResources/adminapp-npm ci-npm run lint && npm test && npm run build-```--That writes `admin.bootstrap.js/.css/.rtl.css`, `admin.grid.js/.css`,-and `admin.ui.js/.css` into-`src/Web/Grand.SharedUIResources/wwwroot/administration/bundles`. The same rule-applies: the bundles are committed, so rebuild and commit them with every change-under `adminapp/src`. The panels no longer use Kendo UI. Scripts, styles, the-grid markup, the plugin compatibility shim and the e2e smoke tests are described in-[`adminapp/README.md`](src/Web/Grand.SharedUIResources/adminapp/README.md).--### Running locally--```bashdotnet run --project src/Web/Grand.Web```-`Grand.Web` does not reference the plugins - they install themselves into its-output directory when *they* are built. So build the solution once-(`dotnet build GrandNode.slnx`) before the first run; after that you can start the-web project alone.--The Kestrel profile listens on <https://localhost:5001> and-<http://localhost:5000>; the Visual Studio IIS Express profile uses-<https://localhost:44350>.--> **Set `ASPNETCORE_ENVIRONMENT=Development`.** Both launch profiles already do.-> If you start the application without it, the static web assets manifest is not-> consulted, every file served from `_content/...` returns 404 and the admin-> panel loads with no CSS and no JavaScript at all. It looks like a broken-> install; it is only the missing environment variable.--On the first run the application redirects to `/install`, where you enter the-MongoDB connection string (for example `mongodb://localhost/grandnode`) and the-administrator account, and choose whether to load the sample data. The installer-writes the connection string to `src/Web/Grand.Web/App_Data/Settings.cfg`, which-is not tracked by git - delete that file to run the installer again against a-fresh database.--### Online demo-#### Frontend ####-[https://demo.grandnode.com/](https://demo.grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme)+Build the whole solution once before the first run: plugins and modules copy themselves into the web project's+output when they are built. Run with `ASPNETCORE_ENVIRONMENT=Development` (the launch profiles already set it),+otherwise the admin panel loads without its CSS and JavaScript.-#### Backend ####-[https://demo.grandnode.com/admin](https://demo.grandnode.com/admin/?utm_source=github&utm_medium=link&utm_campaign=readme)+More ways to install - several instances behind a load balancer, hosting on Linux with systemd - are in+[docs/installation.md](docs/installation.md). Building the frontend bundles and working on the code are in+[docs/development.md](docs/development.md).+## Online demo-Demo is restoring once per day to the original state.+* Storefront: [demo.grandnode.com](https://demo.grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme)+* Admin panel: [demo.grandnode.com/admin](https://demo.grandnode.com/admin/?utm_source=github&utm_medium=link&utm_campaign=readme) - email `[email protected]`, password `123456`-Access to the admin panel:+The demo is restored to its original state once per day.-Admin email: [email protected]+## Documentation-Admin password: 123456+* [Installation](docs/installation.md) - Docker, multiple instances, Linux hosting+* [Development](docs/development.md) - building the backend and frontend, running locally+* [User and developer guides](https://docs.grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=readme) on docs.grandnode.com+* [Contributing guide](CONTRIBUTING.md)+## Community and support-## Roadmap--We have a clear vision in which direction we would like to develop GrandNode. Ready roadmaps with milestones for future versions of GrandNode can be found in the [projects tab](https://github.com/grandnode/grandnode2/projects).+* Questions and ideas: [GitHub Discussions](https://github.com/grandnode/grandnode2/discussions)+* Bugs and feature requests: [GitHub Issues](https://github.com/grandnode/grandnode2/issues/new/choose)+* Security vulnerabilities: see the [security policy](SECURITY.md) - please do not open public issues+* Commercial help: [premium support packages](https://grandnode.com/premium-support-packages/?utm_source=github&utm_medium=link&utm_campaign=readme)+See [SUPPORT.md](SUPPORT.md) for where each kind of question goes.## Contributing-GrandNode is and always will be free and open-source.-How to contribute:-- Star this project on GitHub.-- Report bugs or suggest features by creating new issues-- Submit pull requests-- Become a sponsor and donate to us--## Sponsors--Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/grandnode#sponsor)]+GrandNode is and always will be free and open-source. You can help by:-## Why Choose GrandNode?+- starring the project on GitHub, so other .NET developers find it,+- reporting bugs and suggesting features in [Issues](https://github.com/grandnode/grandnode2/issues/new/choose),+- picking up a [good first issue](https://github.com/grandnode/grandnode2/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) and submitting a pull request - see [CONTRIBUTING.md](CONTRIBUTING.md),+- becoming a sponsor.-GrandNode stands out in the crowded e-commerce platform market by offering:+GrandNode has adopted the Contributor Covenant as its [Code of Conduct](CODE_OF_CONDUCT.md).-- **Superior Performance** - MongoDB and ASP.NET Core ensure lightning-fast page loads-- **Ultimate Scalability** - From startup to enterprise, grow without limits-- **Lower Total Cost of Ownership** - Free, open-source with no licensing costs-- **Modern Technology Stack** - Built with future-proof technologies-- **Extensible Architecture** - Build custom modules and integrations--Whether you're launching a single online store or building a complex multi-vendor marketplace, GrandNode provides the tools and performance you need to succeed in today's competitive e-commerce landscape.--## Code of conduct+## Sponsors-To clarify behavior rules in our community, GrandNode has adopted the code of conduct defined by the Contributor Covenant. For more information see the [Code of Conduct.](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)+Become a sponsor and get your logo on this README with a link to your site:+[become a sponsor on Open Collective](https://opencollective.com/grandnode#sponsor).## License-GrandNode is completely free and distributed under the GNU General Public License v3.0. It's available [here](LICENSE)\ No newline at end of file++GrandNode is free software distributed under the [GNU General Public License v3.0](LICENSE).diff --git a/SECURITY.md b/SECURITY.mdnew file mode 100644index 000000000..a6fe29c74--- /dev/null+++ b/SECURITY.md@@ -0,0 +1,24 @@+# Security Policy++## Supported versions++Security fixes are made on the `develop` branch and shipped in the next release. We recommend running the+[latest stable release](https://github.com/grandnode/grandnode2/releases/latest) and upgrading when a new one is+published.++## Reporting a vulnerability++**Please do not report security vulnerabilities through public GitHub issues, discussions or pull requests.**++Report them privately through GitHub's+[vulnerability reporting form](https://github.com/grandnode/grandnode2/security/advisories/new). Include as much+of the following as you can:++* the type of issue (for example cross-site scripting, broken access control, injection),+* the affected component and the files or URLs involved,+* the GrandNode version or commit you tested,+* step-by-step instructions or a proof of concept to reproduce it,+* the impact, as you understand it.++We will acknowledge the report, keep you informed while we work on a fix, and credit you in the security+advisory unless you prefer to stay anonymous.diff --git a/SUPPORT.md b/SUPPORT.mdnew file mode 100644index 000000000..24b714275--- /dev/null+++ b/SUPPORT.md@@ -0,0 +1,13 @@+# Getting help with GrandNode++| You want to... | Go to |+| --- | --- |+| Ask a question, share an idea or show your project | [GitHub Discussions](https://github.com/grandnode/grandnode2/discussions) |+| Report a bug or request a feature | [GitHub Issues](https://github.com/grandnode/grandnode2/issues/new/choose) |+| Report a security vulnerability | [Private vulnerability report](https://github.com/grandnode/grandnode2/security/advisories/new) - see [SECURITY.md](SECURITY.md) |+| Install, configure or build GrandNode | [docs/installation.md](docs/installation.md), [docs/development.md](docs/development.md) and [docs.grandnode.com](https://docs.grandnode.com/?utm_source=github&utm_medium=link&utm_campaign=support) |+| Get commercial help with an installation, upgrade or custom development | [Premium support packages](https://grandnode.com/premium-support-packages/?utm_source=github&utm_medium=link&utm_campaign=support) |+| Find themes and plugins | [Themes](https://grandnode.com/grandnode-themes/?utm_source=github&utm_medium=link&utm_campaign=support) and [extensions](https://grandnode.com/extensions/?utm_source=github&utm_medium=link&utm_campaign=support) |++When you ask for help, include the GrandNode version, how you run it (Docker, Linux, Windows) and the exact+error message - it saves a round trip.diff --git a/docs/development.md b/docs/development.mdnew file mode 100644index 000000000..c476e80ea--- /dev/null+++ b/docs/development.md@@ -0,0 +1,107 @@+# Development++How to build GrandNode from source, rebuild the frontend bundles and run the application locally.+For the tools and versions you need, see [Prerequisites](../README.md#prerequisites).++## Building the backend++```bash+dotnet restore GrandNode.slnx+dotnet build GrandNode.slnx+```++`GrandNode.slnx` contains the whole application: the core libraries, the web+project, the modules under `src/Modules` (installer, migrations, REST API,+scheduled tasks) and the plugins under `src/Plugins`. Building the solution+builds them all and copies each module and plugin into+`src/Web/Grand.Web/Modules` / `Plugins`, so a plain `dotnet build` is enough.++Two things worth knowing:++* **Plugins that ship views compile those views into the plugin DLL.** After+ editing a `.cshtml` file in, for example, `src/Plugins/Theme.Modern`, rebuild+ that plugin (`dotnet build src/Plugins/Theme.Modern`) - the running site will+ not pick the change up otherwise. Razor runtime compilation covers only+ `Grand.Web`'s own views. Stop the site before rebuilding a plugin, or the+ build fails on a locked DLL.+* Building a plugin on its own is fine and is what the Docker image does; you+ only need the full solution build after changing shared code.++## Building the frontend++The repository has two npm projects: the storefront (below) and the Admin, Store+and Vendor panels (at the end of this section).++The storefront UI (Vue 3, Bootstrap 5) lives in `src/Web/Grand.Web/vueapp`:++```bash+cd src/Web/Grand.Web/vueapp+npm install+npm run build+```++That writes into `src/Web/Grand.Web/wwwroot/bundles`:++| output | contents |+| --- | --- |+| `app.runtime.bundle.js` | Vue 3, the compatibility layer, the per-page view-models and the shared DOM behaviours |+| `libs.css` | Bootstrap, Bootstrap Icons, animate.css, Pikaday |+| `style.min.css`, `style.rtl.min.css` | the theme stylesheets from `wwwroot/theme/css`, concatenated in cascade order and minified |++**This output is committed to the repository**, which is why neither the CI+workflows nor the Dockerfile install Node - they build the .NET solution against+the bundles already in the tree. The flip side is that when you change anything+under `vueapp/src` or `wwwroot/theme/css` you have to run `npm run build` and+commit the regenerated bundles together with the source change, otherwise your+change simply will not be on the page.++Other scripts: `npm run dev` (watch build), `npm run lint` (ESLint over+`vueapp/src`), `npm run audit:prod`. More detail in+[`vueapp/README.md`](../src/Web/Grand.Web/vueapp/README.md).++The Admin, Store and Vendor panels (Bootstrap 5, the Tabulator-based+`<admin-grid>`, vanilla JS widgets) are built by+`src/Web/Grand.SharedUIResources/adminapp`:++```bash+cd src/Web/Grand.SharedUIResources/adminapp+npm ci+npm run lint && npm test && npm run build+```++That writes `admin.bootstrap.js/.css/.rtl.css`, `admin.grid.js/.css`,+and `admin.ui.js/.css` into+`src/Web/Grand.SharedUIResources/wwwroot/administration/bundles`. The same rule+applies: the bundles are committed, so rebuild and commit them with every change+under `adminapp/src`. The panels no longer use Kendo UI. Scripts, styles, the+grid markup, the plugin compatibility shim and the e2e smoke tests are described in+[`adminapp/README.md`](../src/Web/Grand.SharedUIResources/adminapp/README.md).++## Running locally++```bash+dotnet run --project src/Web/Grand.Web+```++`Grand.Web` does not reference the plugins - they install themselves into its+output directory when *they* are built. So build the solution once+(`dotnet build GrandNode.slnx`) before the first run; after that you can start the+web project alone.++The Kestrel profile listens on <https://localhost:5001> and+<http://localhost:5000>; the Visual Studio IIS Express profile uses+<https://localhost:44350>.++> **Set `ASPNETCORE_ENVIRONMENT=Development`.** Both launch profiles already do.+> If you start the application without it, the static web assets manifest is not+> consulted, every file served from `_content/...` returns 404 and the admin+> panel loads with no CSS and no JavaScript at all. It looks like a broken+> install; it is only the missing environment variable.++On the first run the application redirects to `/install`, where you enter the+MongoDB connection string (for example `mongodb://localhost/grandnode`) and the+administrator account, and choose whether to load the sample data. The installer+writes the connection string to `src/Web/Grand.Web/App_Data/Settings.cfg`, which+is not tracked by git - delete that file to run the installer again against a+fresh database.+diff --git a/docs/installation.md b/docs/installation.mdnew file mode 100644index 000000000..3e3c5d920--- /dev/null+++ b/docs/installation.md@@ -0,0 +1,118 @@+# Installing GrandNode++GrandNode can be installed in a few different ways. The `develop` branch is the development version of+GrandNode and may be unstable. The `main` branch contains the latest stable version. You can also download a+specific stable version from the [Releases](https://github.com/grandnode/grandnode2/releases) page or switch+to a release branch.++* [Docker](#docker)+* [Running more than one instance](#running-more-than-one-instance)+* [Open locally in an IDE](#open-locally-in-an-ide)+* [Host on a Linux server](#host-on-a-linux-server)++For the tools and versions you need, see [Prerequisites](../README.md#prerequisites).++## Docker++```bash+docker run -d -p 127.0.0.1:27017:27017 --name mongodb mongo+docker run -d -p 80:8080 --name grandnode2 --link mongodb:mongo -v grandnode_images:/app/wwwroot/assets/images -v grandnode_appdata:/app/App_Data grandnode/grandnode2+```++To run a specific stable version, pull its tag, where `x.xx` is a GrandNode release number:++```bash+docker pull grandnode/grandnode2:x.xx+```++## Running more than one instance++Files GrandNode writes at runtime (sitemap XML files, custom CSS/JS, uploaded images, thumbnails, the push+service worker) live in `wwwroot` by default, so with several instances each one only sees its own. Point+`Application:MediaPath` at a volume shared by all instances (ReadWriteMany in Kubernetes: Azure Files, EFS, NFS):++```bash+docker run -d -p 80:8080 --name grandnode2 --link mongodb:mongo \+ -e Application__MediaPath=/app/media -v grandnode_media:/app/media \+ -v grandnode_appdata:/app/App_Data grandnode/grandnode2+```++Files that ship with the build stay in `wwwroot` and are used until the shop overwrites them. When switching an+existing installation, **move** (not copy) `wwwroot/assets/custom`, `wwwroot/assets/images/uploaded`,+`wwwroot/sitemap*.xml`, `wwwroot/firebase-messaging-sw.js` and, with pictures stored on disk, the+`wwwroot/assets/images/*_0.*` originals into the same paths under the media path, then stop mounting the old+`wwwroot/assets/images` volume. With the `Directory` setting configured, both sides carry it as a prefix: move+`wwwroot/{Directory}/assets/custom` to `{MediaPath}/{Directory}/assets/custom`, and so on. Without the move, each+instance serves its own copy of the sitemap until the sitemap task runs again, and of the push service worker until+the push notification settings are saved again. A file left behind in `wwwroot` keeps being served after it is+deleted in the admin, because the shop only deletes on the media path. Thumbnails are regenerated on the media path.++## Open locally in an IDE++Extract the source code package downloaded from the Releases tab to a folder (or clone the repository), and open+`GrandNode.slnx`. Build the whole solution - that compiles the modules and plugins into the web project's output+as well - then set `Grand.Web` as the startup project and run it. See [Development](development.md) for the+command line equivalent and for the frontend build.++## Host on a Linux server++Before you start, install and configure the nginx server, the .NET 10 SDK and MongoDB 4.0+.++```bash+mkdir ~/source+cd ~/source+git clone -b x.xx https://github.com/grandnode/grandnode2.git+```++```bash+cd ~/source/grandnode2+dotnet restore GrandNode.slnx+```++Now rebuild all modules and plugins and publish the application. Each module and plugin copies itself into the+web project's output, so they have to be built *before* the publish step:++```bash+for module in src/Modules/*; do dotnet build "$module" -c Release; done+for plugin in src/Plugins/*; do dotnet build "$plugin" -c Release; done+dotnet publish src/Web/Grand.Web -c Release -o /var/webapps/grandnode+```++Optional: create the service file, to automatically restart your application.++```bash+sudo vi /etc/systemd/system/grandnode.service+```++Paste the following content, and save changes:++```ini+[Unit]+Description=GrandNode++[Service]+WorkingDirectory=/var/webapps/grandnode+ExecStart=/usr/bin/dotnet /var/webapps/grandnode/Grand.Web.dll+Restart=always+RestartSec=10+SyslogIdentifier=dotnet-grandnode+User=www-data+Environment=ASPNETCORE_ENVIRONMENT=Production++[Install]+WantedBy=multi-user.target+```++Enable the service and start GrandNode:++```bash+sudo systemctl enable grandnode.service+sudo systemctl start grandnode.service+```++## First run++On the first run the application redirects to `/install`, where you enter the MongoDB connection string (for+example `mongodb://localhost/grandnode`) and the administrator account, and choose whether to load the sample+data. The installer writes the connection string to `App_Data/Settings.cfg` - delete that file to run the+installer again against a fresh database.