Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 4.23 KB

README.md

File metadata and controls

70 lines (46 loc) · 4.23 KB

Nuget.org Appveyor Coverage Status

Current status

A .NET Core version of Roadkill was started in the https://github.com/roadkillwiki/roadkill_new repository.

While this .NET Core project is 99% functionally complete on the API-side, it stopped at .NET 5. It hasn't been continued because of the large amount of work involved with integrating an OAuth2 solution, and rewriting the front-end as a SPA using React or similar.

Forking the .NET Core repository is welcome, if you'd like to implement an OAuth solution (that is FOSS, which IdentityServer no longer is) and a SPA front end using React, VueJS or similar.

This repository - Roadkill .NET Framework - is quite old now, but fully functional should you want to use it.

Introduction

Roadkill .NET is a lightweight but powerful Wiki platform built on the following foundations:

  • .NET 4.5
  • jQuery
  • ASP.NET MVC 5 with Razor
  • Lucene.net search engine
  • Creole, Media Wiki and Markdown syntax support
  • Bootstrap 3 based UI.
  • Supports SQL Server, SQL Server CE, SQL Azure (v1.6+), Sqlite, MySQL, Postgres, MongoDB
  • It's themeable and extendable, has documentation, supports Active Directory authentication and is (I hope) extremely easy to use. It's Free Open Source (FOSS)

Roadkill is licensed under the MS-PL license which means it's free to use commercially or privately, but requires you to retain the copyright, trademark and attribution if you intend to distribute it (typically for commercial gain).

Quick start: Azure and AWS

  • AWS t2.micro is generally big enough for a small site. Note: this AMI is Windows 2016 July 2018. It may need updating after launch via RDP.
  • Azure instructions
  • Google Cloud: looking for help

For Developers

Pre-requisites

Make sure you use the version-2 branch, master is not currently stable

To setup Roadkill on a developer machine, you will need:

  • Visual Studio 2015, Community Edition is fine, Roadkill is written using Community Edition.
  • IIS
  • SQL Server. Your SQL Server installation should be the default instance (not YOURMACHINE\SQLEXPRESS) for the tests to pass. They rely on the connection string being Server=(local);Integrated Security=true;Connect Timeout=5;database=Roadkill
  • An NUnit runner (NUnit, Resharper, Dotcover etc.) if you want to run the tests. This is required if you want to contribute.

Fresh install

To get a 'fresh' Roadkill installation on your development machine, you will need to do the following:

Contributing

No contributions are currently being taken as the project is frozen.