add a quickstart

docs/get-started/create-your-mine.rst

@@ -1,12 +1,14 @@
 Create Your InterMine!
 ==============================
 
-This guide will show you how to create a new InterMine. You will need all the dependencies listed in :doc:`/system-requirements/software/index`
+This guide will show you how to create a new InterMine. You will need all the dependencies listed in :doc:`/system-requirements/software/index`.
 
 .. note::
 
     These instructions assume you have taken the :doc:`/get-started/tutorial/index`, a detailed guide to integrating data with InterMine.
 
+See :doc:`/get-started/quick-start` to run our test InterMine - BioTestMine.
+
 1. Run a script to create your InterMine
 ----------------------------------------
 
@@ -156,8 +158,11 @@ See :doc:`/system-requirements/software/gradle/index` for more on Gradle.
 Next steps
 ----------------------------
 
-Congratulations! Next you will want to:
+Congratulations! You now have an InterMine! Visit it at localhost:8080/tigermine. (replace `tigermine` with the name your chose for your mine)
+
+Next you will want to:
 
+* `learn how to use the InterMine webapp <http://intermine.org/tutorials/>`_
 * :doc:`customise your mine </webapp/properties/index>` 
 * :doc:`add your own data sources </database/data-sources/custom/index>` 
 * :doc:`join the intermine mailing list </support/mailing-list>`

docs/get-started/index.rst

@@ -6,6 +6,7 @@ Get started
 
    tutorial/index
    tutorial/webapp
+   quick-start
    create-your-mine
    testmine
    intermine-tests

docs/get-started/quick-start.rst

@@ -0,0 +1,89 @@
+Quick Start
+==============================
+
+This guide will show you how to create a `BioTestMine` InterMine instance. You will need all the dependencies listed in :doc:`/system-requirements/software/index`
+
+.. note::
+
+    Please see :doc:`/get-started/tutorial/index`, a detailed guide to integrating data with InterMine.
+
+
+    Replace PSQL_USER and PSQL_PWD with your postgres username and password.
+
+    (Optional) Initialise the two search repositories used by InterMine. Follow the instructions here:
+
+    https://intermine.readthedocs.io/en/latest/system-requirements/software/solr/
+
+If you don't do this, the keyword search won't work in your mine. 5. Run build script in this repository:
+
+./setup.sh
+
+
+
+1. Get the software
+----------------------------------------
+
+Clone the repository
+
+::
+
+    ~/git/ $ git clone https://github.com/intermine/biotestmine.git
+
+
+You now have an InterMine! The :doc:`tutorial </get-started/tutorial/index>` goes into detail about the various files that comprise an InterMine.
+
+2. Add a mine properties file
+------------------------------
+
+Your InterMine uses a properties file for database usernames and passwords, let's create that file now.
+
+Make an intermine directory in your home directory.
+
+::
+
+    # change to be in your home directory
+    ~/git $ cd
+    # make an intermine directory
+    ~ $ mkdir .intermine
+
+Copy the properties file from the git repository to your local InterMine directory.
+
+::
+   
+    ~/.intermine $ cp ~/git/biotestmine/data/biotestmine.properties
+
+Now update your new properties files with the values correct for your InterMine. Replace PSQL_USER and PSQL_PWD with your postgres username and password.
+
+See :doc:`/webapp/properties/intermine-properties` for details on this file and what each property means.
+
+3. Set up your search index (optional)
+---------------------------------------
+
+Solr handles the keyword search in InterMine. See :doc:`/system-requirements/software/solr` for details on how to set Solr up for your mine.
+
+If you skip this step, your mine will work fine but the keyword search will fail.
+
+4. Build + deploy your webapp
+------------------------------
+
+Now run the build!
+
+::
+
+  ~/git/tigermine $ ./setup.sh
+
+Your build (depending on your server) will take a few minutes to run.
+
+Next steps
+----------------------------
+
+Congratulations! You now have an InterMine! Visit it at localhost:8080/biotestmine.
+
+Next you will want to:
+
+* `learn how to use the InterMine webapp <http://intermine.org/tutorials/>`_
+* :doc:`customise your mine </webapp/properties/index>` 
+* :doc:`add your own data sources </database/data-sources/custom/index>` 
+* :doc:`join the intermine mailing list </support/mailing-list>`
+
+.. index:: Quick start, biotestmine

docs/get-started/tutorial/index.rst

@@ -7,6 +7,10 @@ Following the steps on this page you will set up an example InterMine.  You will
  * Learn about how data integration works
  * Deploy a webapp to query the data
 
+.. note::
+
+  See :doc:`/get-started/quick-start` if you are impatient and just want to run an InterMine.
+
 Getting Started
 ----------------------