diff --git a/README.md b/README.md index f64a04da..6ff53ce3 100644 --- a/README.md +++ b/README.md @@ -14,26 +14,44 @@ Oqtane is being developed based on some fundamental principles which are outline Please note that this project is owned by the .NET Foundation and is governed by the **[.NET Foundation Contributor Covenant Code of Conduct](https://dotnetfoundation.org/code-of-conduct)** -# Getting Started +# Getting Started (Version 5.x) -**Using Version 5:** +**Installing using source code from the Dev/Master branch:** - Install **[.NET 8.0.8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)**. - Install the latest edition (v17.9 or higher) of [Visual Studio 2022](https://visualstudio.microsoft.com/downloads) with the **ASP.NET and web development** workload enabled. Oqtane works with ALL editions of Visual Studio from Community to Enterprise. If you wish to use LocalDB for development ( not a requirement as Oqtane supports SQLite, mySQL, and PostgreSQL ) you must also install the **Data storage and processing**. -- Clone the Oqtane dev branch source code to your local system. +- Clone (or download) the Oqtane Master or Dev branch source code to your local system. - Open the **Oqtane.sln** solution file. -- **Important:** Rebuild the entire solution before running it. +- **Important:** Rebuild the entire solution before running it (ie. Build / Rebuild Solution). -- Make sure you specify Oqtane.Server as the Startup Project +- Make sure you specify Oqtane.Server as the Startup Project. -- Run the application. +- Run the application... an Installation Wizard screen will be displayed which will allow you to configure your preferred database and create a host user account. + +**Developing a custom module:** + +- follow the instructions for installing using source code outlined above + +- login as the host user + +- navigate to Control Panel, Admin Dashboard, Module Management + +- select Create Module + +- enter information corresponding to the module you wish to create and then select the Create button + +- make note of the Location where the code was generated and open the solution file in Visual Studio + +- Build / Rebuild Solution, ensure the Oqtane.Server is set as the Startup Project, and hit F5 to run the solution **Installing an official release:** +- A detailed set of instructions for installing Oqtane on Azure is located here: [Installing Oqtane on Azure](https://blazorhelpwebsite.com/ViewBlogPost/1) + - A detailed set of instructions for installing Oqtane on IIS is located here: [Installing Oqtane on IIS](https://www.oqtane.org/Resources/Blog/PostId/542/installing-oqtane-on-iis) - Instructions for upgrading Oqtane are located here: [Upgrading Oqtane](https://www.oqtane.org/Resources/Blog/PostId/543/upgrading-oqtane)