madskristensen / Miniblog.Core

An ASP.NET Core blogging engine
https://miniblogcore.azurewebsites.net/
Other
1.48k stars 498 forks source link

What is meant by blogging engine - how to use it? #123

Open rswetnam opened 4 years ago

rswetnam commented 4 years ago

I've been aware of this great resource for some time now and use it to learn about techniques and best practices. However, I've never been really sure how it's meant to be used. Is the idea that it would be the start of a new web site that the person downloading the code would add some styling and other features to in order to personalize it and then publish it? Or perhaps it's an engine that could be incorporated into an existing site. (I tried the latter but got bogged down and abandoned the attempt) It would be great if your documentation could address how you would see this engine being used.

ManfredLange commented 4 years ago

@rswetnam The purpose of this repository is providing an implementation of a simple blogging engine based on .NET Core. One way to use it, is cloning this repository, building it and then deploying it to an environment capable of running .NET Core 3.1 web applications. It also needs write access to a local drive. Please make sure you check the settings. Important: In particular change the credentials (username and password) in file appsettings.json as otherwise other people will be able to make modifications to your blog posts.

Once deployed you can then use the logging engine as your own blogging site as you please. Whether that is enough to constitute an entire "web site" is a question only you can answer.

If you want to make it an element of a larger web site there are a number of options. The least effort is probably to deploy the blog as a standalone site, then perhaps use a subdomain of your main site. You'd then want to look at styling and layout to make it more consistent. You can change the stylesheet(s) and with a bit more effort you can also attempt to change the layout.

Alternatively, you could consider extending Miniblog.Core so that you can embed it in a different web site. There are several variations for how this could be done, e.g. including UI or just via API. I won't go into further details as it would be way beyond a comment here.

However, as I understand it, Miniblog.Core was meant to be a starting position for someone who knows how to develop a web application. So I think there is an expectation you'd be able to change views or layout, add more features (as needed), etc. unless you're happy to use it "as-is". If you need a more functional option without having to do any work, then perhaps Miniblog.Core is not the ideal choice for you.

I hope this helps with your decision making.

wpqs commented 3 years ago

Inspired by this issue I have written a couple of posts that may help anyone looking for information about what Miniblog does and how to implement it: