From 08ece67f53f39f4f1aa89f8ebc896b9f5665d010 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mat=C3=ADas=20Molleja?= Date: Sat, 23 Mar 2019 14:17:44 +0100 Subject: [PATCH 1/3] Add new guide about creating cms application --- src/docs/guides/README.md | 1 + .../guides/create-cms-application/index.md | 61 +++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 src/docs/guides/create-cms-application/index.md diff --git a/src/docs/guides/README.md b/src/docs/guides/README.md index 0da69e28e2c..61035edf4c8 100644 --- a/src/docs/guides/README.md +++ b/src/docs/guides/README.md @@ -7,6 +7,7 @@ Whatever you're building, these guides are designed to get you productive as qui Designed to be completed in 15-30 minutes, these guides provide quick, hands-on instructions for building the "Hello World" of any development task with Orchard Core. In most cases, the only prerequisites are a .NET SDK and a text editor. - [Creating a Modular ASP.NET Core Application](create-modular-application-mvc/index.md) +- [Creating a CMS Application](create-cms-application/index.md) - [Running Code on Startup](run-code-on-startup/index.md) ## Tutorials diff --git a/src/docs/guides/create-cms-application/index.md b/src/docs/guides/create-cms-application/index.md new file mode 100644 index 00000000000..3dfc90a11a5 --- /dev/null +++ b/src/docs/guides/create-cms-application/index.md @@ -0,0 +1,61 @@ +# Creating a CMS Application + +In this guide you will setup Orchard Core as a Content Management System. + +## What you will need + +- The current version of the .NET Core SDK. You can download it from here [https://www.microsoft.com/net/download/core](https://www.microsoft.com/net/download/core). + +- A text editor and a terminal where you can type dotnet commands. + +## Creating an Orchard Core Site + +There are different ways to create sites and modules for Orchard Core. You can learn more about them [here](../../templates/README.md). In this guide we will use our "Code Generation Templates". + +You can install the latest released templates using this command: + +```dotnet new -i OrchardCore.ProjectTemplates::1.0.0-*``` + +!!! note + To use the development branch of the template add `--nuget-source https://www.myget.org/F/orchardcore-preview/api/v3/index.json` + +Create an empty folder that will contain your site. Open a terminal, navigate to that folder and run this: + +```dotnet new occms -n MySite``` + +This creates a new ASP.NET MVC application in a new folder named `MySite`. + +## Setting Up the Site + +The application has been created by the template, but it has not been setup yet. + +Orchard Core is modular. It means that depending on what modules you include in your application it can be many different things. Which modules are included is determined by the specific `Recipe` selected during setup. +In order to build a site with all the features of a CMS with are going to use the `Blog` recipe. + +Run the application by executing this command: + +`dotnet run --project .\MySite\MySite.csproj` + +!!! note + If you are using the development branch of the templates, run `dotnet restore .\MySite\MySite.csproj --source https://www.myget.org/F/orchardcore-preview/api/v3/index.json` before running the application + +Your application should now be running and contain the open ports: + +``` +Now listening on: https://localhost:5001 +Now listening on: http://localhost:5000 +Application started. Press Ctrl+C to shut down. +``` + +Open a browser on +It should display the setup screen. +Fill the form and select the `Blog` recipe. +For this exercise, you would want to use `Sqlite` as the database engine. + +Submit the form. A few seconds later you should be looking at a Blog Site. +In order to configure it and start writing content you can go to . + + +## Summary + +You just created a full blown CMS site. From 8212bc30ec82ca5a9a3df9040b3a8c884de41f46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Ros?= Date: Sun, 24 Mar 2019 12:18:21 -0700 Subject: [PATCH 2/3] Update README.md --- src/docs/guides/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/guides/README.md b/src/docs/guides/README.md index 61035edf4c8..67c2b4a615d 100644 --- a/src/docs/guides/README.md +++ b/src/docs/guides/README.md @@ -7,7 +7,7 @@ Whatever you're building, these guides are designed to get you productive as qui Designed to be completed in 15-30 minutes, these guides provide quick, hands-on instructions for building the "Hello World" of any development task with Orchard Core. In most cases, the only prerequisites are a .NET SDK and a text editor. - [Creating a Modular ASP.NET Core Application](create-modular-application-mvc/index.md) -- [Creating a CMS Application](create-cms-application/index.md) +- [Creating an Orchard Core CMS website](create-cms-application/index.md) - [Running Code on Startup](run-code-on-startup/index.md) ## Tutorials From fb55b63bbdc4a92a893e579c1d06e2a62d1e67a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Ros?= Date: Sun, 24 Mar 2019 12:25:56 -0700 Subject: [PATCH 3/3] Update index.md --- .../guides/create-cms-application/index.md | 26 ++++++++----------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/src/docs/guides/create-cms-application/index.md b/src/docs/guides/create-cms-application/index.md index 3dfc90a11a5..8313b6192c5 100644 --- a/src/docs/guides/create-cms-application/index.md +++ b/src/docs/guides/create-cms-application/index.md @@ -1,14 +1,13 @@ -# Creating a CMS Application +# Creating an Orchard Core CMS website -In this guide you will setup Orchard Core as a Content Management System. +In this guide you will setup Orchard Core as a Content Management System from a project template. ## What you will need - The current version of the .NET Core SDK. You can download it from here [https://www.microsoft.com/net/download/core](https://www.microsoft.com/net/download/core). - - A text editor and a terminal where you can type dotnet commands. -## Creating an Orchard Core Site +## Creating the projects There are different ways to create sites and modules for Orchard Core. You can learn more about them [here](../../templates/README.md). In this guide we will use our "Code Generation Templates". @@ -23,15 +22,12 @@ Create an empty folder that will contain your site. Open a terminal, navigate to ```dotnet new occms -n MySite``` -This creates a new ASP.NET MVC application in a new folder named `MySite`. +This creates a new Ochard Core CMS project in a folder named `MySite`. -## Setting Up the Site +## Setting up the site The application has been created by the template, but it has not been setup yet. -Orchard Core is modular. It means that depending on what modules you include in your application it can be many different things. Which modules are included is determined by the specific `Recipe` selected during setup. -In order to build a site with all the features of a CMS with are going to use the `Blog` recipe. - Run the application by executing this command: `dotnet run --project .\MySite\MySite.csproj` @@ -47,15 +43,15 @@ Now listening on: http://localhost:5000 Application started. Press Ctrl+C to shut down. ``` -Open a browser on -It should display the setup screen. -Fill the form and select the `Blog` recipe. -For this exercise, you would want to use `Sqlite` as the database engine. +Open a browser on , it should display the setup screen. + +In order to build a site with all the features of a CMS with are going to use the __Blog__ recipe. Recipes contains a list of modules and steps to configure an Orchard Core website. + +Fill the form and select the __Blog__ recipe and __SQLite__ for the database. Submit the form. A few seconds later you should be looking at a Blog Site. In order to configure it and start writing content you can go to . - ## Summary -You just created a full blown CMS site. +You just created an Orchard Core CMS powered blog engine.