Getting started with the backend

The Weavy backend is a web application that you deploy to your hosting environment of choice.

Prerequisites

The Weavy backend is built on .NET which is a free, cross-platform, open-source developer platform. The following is required to download, build and run the application.

Download Weavy

The code is available on GitHub and the repo contains a fully functional ASP.NET MVC Core web application that you can download and build on your local machine.

In a terminal window, run the following command to clone the repository:

git clone https://github.com/weavy/weavy-server.git

Instead of cloning, you can also fork the repo. This lets you make changes to the project and allows you to easily fetch updates when we release new versions of Weavy.

Create database

Open SQL Server Management Studio and create a new database (we suggest you call it weavy).

Configure app settings

Create a file named appsettings.json in the src folder. Add settings for database connection string and license as described below:

{
  "ConnectionStrings": {
    "Weavy": "server=localhost;database=weavy;trusted_connection=true;"
  },
  "Weavy": {
    "License": "YOUR-LICENSE-KEY"
  }
}

If you don't have a license key you can go to https://www.weavy.com and sign up (for free) to get one.

Build and run

Once the repo is cloned, the database is created, and the app settings have been configured, you can build and run the application.

Open a terminal window in the src folder and run the following command:

dotnet run

If the application does not start, or if you get an error on startup, the console should contain an error message describing the problem.

Alternatively, if you have Visual Studio installed, you can also open the weavy-server.sln file and select "Debug > Start Without Debugging" from the menu (or press Ctrl+F5) to build and run the application.

Next steps

For more information, see the following resources:

Weavy Docs