How to set up an Associativy development environment

Using Associativy modules as a non-developer

If you run an Orchard site, you can install Associativy modules from the dashboard gallery just as any other module. Associativy will run and you can create cool knowledge graphs with it by only using the UI.

Using Associativy modules to develop new modules upon them

If you develop Orchard modules you're already running Orchard from Visual Studio, using the full source code. You now have two options, use them to meet you personal preference:

  • Download and install Associativy modules from the Gallery: this way you'll also have the Associativy modules locally in source form, so by including them in your Orchard solution you can start developing new modules, extending the existing Associativy code base. You don't necessarily need to use the Orchard source from the main Orchard repository! Use that only if you'd like to start with a new Orchard instance and don't want to include Associativy modules yourself or if you'd like to contribute to Associativy (see later).
  • Include Associativy modules as subrepos: if you're using the Mercurial source control system already to version control your Orchard solution you can easily add all the Associativy modules as subrepositories to your main repo (for hg urls check the module project pages or copy from the Associativy main repo's .hgsub file). This way you'll be able to easily pull in updates from Associativy repositories.

Setting up a dev environment to contribute to Associativy

Awesome that you're about to form Associativy! To make your life easier you only have to clone the main Associativy repository. This includes all the Associativy modules too.

The main repository also includes the Associativy Notions demo project. As a start you can setup this to have a nice test database, as the following:

  1. After you've cloned the main repo, open the Orchard solution, run the site and install Orchard locally.
  2. Enable the Associatvy Notions feature. This will also enable all the necessary dependencies.
  3. You'll notice that on the admin menu under the Associativy item there are two new graphs: Associativy Notions and Associativy Hungarian Notions. They're empty though. Let's create the Notions graph by visiting http://localhost:2010/Associativy/Associativy.Instances.Notions/Setup/. You'll see "Done". (You can also setup the Hungarian Notions database by analogously opening http://localhost:2010/Associativy/Associativy.Instances.Notions/Setup/Hungarian. Only do this if you understand Hungarian :-).)
  4. Now the Notions graph will have some nodes and edges. You can also explore the graph by viewing it through the enabled frontend engines (listed under the graph's admin page) or add new nodes to it by creating new content items of type Notion.

Have fun!