From ccc810a9fa479e332ba60d66eed94d82feb53694 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Wed, 23 Feb 2022 15:41:01 +0000 Subject: [PATCH] basic contents --- docs/setup-dev-environment.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/setup-dev-environment.md b/docs/setup-dev-environment.md index 07aaebd9..99df8a30 100644 --- a/docs/setup-dev-environment.md +++ b/docs/setup-dev-environment.md @@ -1,11 +1,13 @@ # Setting up a local development environment -This document is intended to guide you through setting up a local development environment for Colouring London. This guide assumes you already have Ubuntu 18.04 or 20.04 server installed, typically installed in a virtual environment such a VirtualBox and are able to SSH into your Ubuntu installation for convenience. +This document is intended to guide you through setting up a local development environment for the Colouring London application. This guide assumes you already have either already have access to an machine with Ubuntu 18.04 or 20.04 installed, or can use VirtualBox to set up an Ubuntu virtual machine as below:
Configuring an Ubuntu VM in VirtualBox - +

+ +Here we explain how to use VirtualBox and SSH into your Ubuntu installation for convenience. When setting up the VirtualBox VM, consider the size of the database you intend to load for use with the application. Consult the [loading the data](#loading-the-data) section of this guide and decide whether you will be using a full city database or will load test data from OSM. @@ -38,6 +40,12 @@ ssh @localhost -p 4022 ```
+## Contents + +- [Set up]() +- [Loading data]() +- [Running the application]() + ## Installing the tools and components First upgrade the installed packages to the latest versions, to remove any security warnings.