From 7dafe304454af5f3c2f1e18ef848445ca6afc9e9 Mon Sep 17 00:00:00 2001 From: Farzin Date: Tue, 23 Mar 2021 17:03:38 +0430 Subject: [PATCH] Quick start added to the readme --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1dc718191..8fe314ac4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -


+

Blogifier Logo @@ -27,17 +27,52 @@ If you are looking for a stable application, please use [latest release](https:/ The latest stable source code is in the [master branch](https://github.com/blogifierdotnet/Blogifier/tree/5c9bab69788a1f7a0bd82c6a864e159eff5b1b72). Please note that newest code uses Blazor Web Assembly and not compatible with previous versions. -## Docs -We publish docs on the Blogifier website. +## Quick Start + +**read-to-use** + +This version is built and compiled, and ready to use: + +> **The only requirement:** .NET Core Runtime 5.0 or above should be installed on your host server. + +1. Download. +2. Unzip and copy to your host server.
+3. Restart your website. +4. Open your website and only the first time you'll be redirected to the register page. `example.com/admin/register/` +5. Register, and then log in. `example.com/admin/login/` +6. Done, enjoy. + +**The Source Code** +If you want to customize the Blogifier, or help us in the development: + +1. [Download](https://dotnet.microsoft.com/download/dotnet/5.0) and Install .NET SDK 5.0 and above. +2. Clone the repository. +3. Open the project with your favorite IDE (VS Code, Visual Studio, Atom, etc). +4. Run the app with your IDE or these commands: + +First go to the Blogifier project folder: +``` +$ cd /your-local-path/blogifier/src/blogifier/ +``` +Then: +``` +$ dotnet run +``` +Then in your browser: +``` +http://localhost:5000 +``` + + +## Docs +We publish docs on the Blogifier website.
[**Explore Blogifier Docs »**](https://blogifier.net/docs/) ## Team - [![@farzindev](https://avatars.githubusercontent.com/u/6384978?s=60&v=4)](https://github.com/farzindev)   [![@rxtur](https://avatars.githubusercontent.com/u/1932785?s=60&v=4)](https://github.com/rxtur) - ## Copyright and License Code released under the MIT License. Docs released under Creative Commons.
Copyright 2017–2021 Blogifier