Skip to content

Commit

Permalink
Quick start added to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
farzindev committed Mar 23, 2021
1 parent da25d42 commit 7dafe30
Showing 1 changed file with 40 additions and 5 deletions.
45 changes: 40 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<br><br><br>
<br><br>
<p align="center">
<a href="https://blogifier.net/">
<img src="https://blogifier.net/files/brand/logo.svg" alt="Blogifier Logo" width="100" height="100">
Expand Down Expand Up @@ -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.<br>
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.<br>
[**Explore Blogifier Docs »**](https://blogifier.net/docs/)

## Team

[![@farzindev](https://avatars.githubusercontent.com/u/6384978?s=60&v=4)](https://github.com/farzindev) &nbsp;
[![@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.<br>
Copyright 2017–2021 Blogifier

0 comments on commit 7dafe30

Please sign in to comment.