Developer Installation

This guide is meant to set up the proper environment for those who wish to develop for the 3D Repository. If you would like to just install and run an instance of the 3DR, then follow the installation guide here.

Please file an issue if you are having problems after carefully following this guide.

Requirements

• Visual Web Developer 2010 Express (or Visual Studio 2010) - website
• Fedora Commons Repository v3.5 - website or direct link to installer
• MySQL Community Server v5.1 or newer - website
• MySQL ODBC Connector v5.1 - website
• 3D Tools library - direct link
• Password Textbox Control - website
• Microsoft Visual C++ 2008 SP1 Redistributable Package - google it, page is different depending on your platform

Installation

Please read these instructions carefully. If you skip over any steps, it is likely you will end up with a configuration error.

Installing the Datastores

The 3DR uses two datastores: MySQL for storing metadata and Fedora Commons for storing content. You must install both before setting up the rest of the 3DR.

1. Install MySQL Community Edition (link is provided above). The default settings should be OK if you are doing local development. Keep your username and password handy.
2. Install the MySQL ODBC Connector from the link provided above. 64-bit users: you must use the 32-bit version for the 3DR. It can be installed in parallel with the 64-bit version for those who have a previous 64-bit installation.
3. Install Fedora Commons by following this guide: https://wiki.duraspace.org/display/FEDORA34/Installation+and+Configuration+Guide. The "quick" option is fine. Don't forget to set all the home variables.

Installing the VC++ 2008 SP1 Redistributable Package

This redistributable is used by the 3D Tools library to handle conversions and parsing of model data. This has a straightforward visual installer for most Windows platforms. Find the correct version for your machine and install it.

Getting the Code and Setting Up the Environment

We are going to assume that if you are on github, you probably already have git set up on your machine. If you don't, an excellent guide can be found here that will have you up and running in no time. These instructions assume you are using the git bash shell for Windows.

1. Clone the repository:

git clone https://github.com/adlnet/3D-Repository.git

1. Create needed directories:

mkdir 3dtools
cd 3D-Repository/VwarWeb
mkdir App_Data && cd App_Data
mkdir imageTemp viewerTemp converterTemp

1. Unzip 3D Tools into {INSTALLATION_LOCATION}\3dtools

Installing the Database

Now we need to create the database and all the tables to store the metadata. Open a command prompt and perform the following actions:

cd {INSTALLATION_DIRECTORY}\Database
mysql -u root -p < setup.sql

Website Configuration

You're almost there! Now you just need to add a web.config file and edit it to match your configuration.

cd {INSTALLATION_DIRECTORY}\VwarWeb
copy web.config.installer.template web.config

1. For each location in the file where you find values surrounded by double square brackets, fill in the information appropriate to your environment. For example, for

[[MySQLIP]]

you would replace it with

127.0.0.1

if you are running locally. You do not have to fill in the information for the Learning Registry section if LR_Integration_Enabled is set to false.

Running

1. Start fedora and MySQL. If you installed MySQL as a service, then you do not need to start it unless you have stopped the service explicitly after installation.

%FEDORA_HOME%\tomcat\bin\startup.bat
cd "C:\Program Files\MySQL\MySQL Server 5.5\bin"
mysqld.exe

1. Open the solution in Visual Studio.
2. Build the Solution (F6). If you encounter any errors about not being able to find 'opp:PasswordTextBox' then you will need to add a reference to the PasswordTextBox project you downloaded as a requirement, then build again.
3. If everything is in the clear, you should be able to launch the 3DR by pressing the 'Play" button or hitting F5. A browser window will open, and after a few seconds you will see your local 3DR instance successfully running!

After everything is set up, you might want some test data to play with. This can easily be achieved by visiting the public 3DR instance at http://3dr.adlnet.gov and downloading models, then uploading them to your local instance.