To get up and running with Redakt quickly and easily, you can use one of the Redakt skeleton projects available on GitHub. The repository contains basic projects for several common hosting scenarios.

Clone the skeleton repository from GitHub, and start with the skeleton project that you want to use. See the following list of skeleton projects included in the repository.

Project list

The repository is organized into subfolders, each containing a single skeleton project:

  • azure-cosmosdb-single
    A single web + back office project based on Azure cloud services with Cosmos DB.

  • azure-cosmosdb-distributed
    Separate web and back office projects (for distributed/load-balanced hosting) based on Azure cloud services with Cosmos DB.

  • aws-mongodb-single
    A single web + back office project based on AWS cloud services and Mongo DB.

  • aws-mongodb-distributed
    Separate web and back office projects (for distributed/load-balanced hosting) based on AWS cloud services and Mongo DB.

  • mongodb-single
    A single web + back office project for on-premises hosting with Mongo DB.

  • mongodb-distributed
    Separate web and back office projects (for distributed/load-balanced hosting) for on-premises hosting with Mongo DB.

  • litedb-single
    A single web + back office project based on LiteDB and local file storage.

Project structure

Apart from the LiteDB project, all skeleton projects require configuration settings for data and file storage. You can set configuration in the appsettings.json file. To keep the skeletons simple, only required Redakt configuration settings have been added to the settings file. If you want to set other (non-required) configuration settings, see the respective module's configuration options.

All solutions have a reference to the shared RedaktSkeleton.ViewModels and RedaktSkeleton.Views projects. These projects contain some basic Redakt content models and Razor views, that you can use as examples for defining your own models and views.

Further reading

You should now have a Redakt website that you can start up and work with. You can access the back office at the default /redakt URL. For further configuration options, see the module configuration guide.

The skeleton only contains basic content models and views. See the content model and view implementation guides to develop your website further.

In this article