Difference between revisions of "Team:Michigan Software/Installation"

 
(8 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
<h1>Installation</h1>
 
<h1>Installation</h1>
−
<p>You can download our project from <a href=https://github.com/igemsoftware/Michigan15>our github</a> or <a href=https://static.igem.org/mediawiki/2015/d/d3/Michigan15.zip>download the wiki freeze version here</a>. We HIGHLY recommend downloading from GitHub, as it will be a more recent, and as a result better, version.<p>
+
<p>You can download our project from <a href=https://github.com/igemsoftware/Michigan15>our github</a> or <a href=https://static.igem.org/mediawiki/2015/d/d3/Michigan15.zip>download the wiki freeze version here</a>. We <em>highly</em> recommend downloading from GitHub, as it will be a more recent, and as a result better, version.<p>
  
−
<h2> Things you need to install before running Protocat </h2>
+
<h2> Pre-installations for Protocat </h2>
 
<h4> Python and Pip </h4>
 
<h4> Python and Pip </h4>
−
<ul>
+
<ol>
−
<li>Run Python 3.4.3 installer from HERE</li>
+
<li>Run the Python 3.4.3 installer from <a href="https://www.python.org/downloads/release/python-343/">here</a></li>
 
<li>Make sure Add Python to PATH is enabled</li>
 
<li>Make sure Add Python to PATH is enabled</li>
−
<li>Newer releases of Python come with Pip installed</li>
+
<li>Newer releases of Python come with Pip pre-installed</li>
−
</ul>
+
</ol>
 +
 
 
<h4>Django</h4>
 
<h4>Django</h4>
−
<ul>
+
<ol>
 
<li>Open Command Prompt(Windows) or Terminal (Mac)</li>
 
<li>Open Command Prompt(Windows) or Terminal (Mac)</li>
 
<li>Use "pip install django" to install the main Django packages</li>
 
<li>Use "pip install django" to install the main Django packages</li>
−
<li>Other necessary installations (nesting list):django-nose, coverage, django_comments, django-contrib-comments</li>
+
<li>Other necessary installations</li>
−
<li>Use "pip install pytz"</li>
+
<ul>
 +
<li>Type "pip install django-nose" into the prompt</li>
 +
<li>Type "pip install coverage" into the prompt</li>
 +
<li>Type "pip install django-contrib-comments" into the prompt</li>
 +
<li>Type "pip install pytz" into the prompt</li>
 +
<li>Type "pip install docutils" into the prompt</li>
 
</ul>
 
</ul>
−
setuptools, github
+
</ol>
  
−
<h2>How to get Protocat up and running </h2>
+
<h4> Github </h4>
−
<ul>
+
<ol>
 +
<li> Install Github from <a href="https://desktop.github.com/"> here</a> </li>
 +
<li> Be sure to select your operating system for the download </li>
 +
<li> Make sure Github has access to PATH</li>
 +
</ol>
 +
 
 +
<h2>Running Protocat </h2>
 +
<ol>
 
<li>Copy the SSH URL from https://github.com/igemsoftware/Michigan15</li>
 
<li>Copy the SSH URL from https://github.com/igemsoftware/Michigan15</li>
−
<li>Inside a terminal/command line, cd into a directory you want this file to be in and use "git clone [the SSH URL]"</li>
+
<li>Inside Command Prompt or Terminal, cd into the directory you want the Michigan15 source file to be in</li>
 +
<li>Type "git clone [the SSH URL]" into the terminal</li>
 
<li>cd Michigan15/mibiosoft</li>
 
<li>cd Michigan15/mibiosoft</li>
−
<li>To run, use "python manage.py runserver" and go to localhost in a web browser or server address</li>
+
<li>To run, use "python manage.py runserver" and type the server address into your web browser</li>
−
<li>To run test coverage, use "python manage.py test protocat_app"</li>
+
<li>Enjoy using Protocat 2.0!</li>
−
</ul>
+
</ol>
  
  

Latest revision as of 14:14, 18 September 2015


Michigan Software 2015

Installation

You can download our project from our github or download the wiki freeze version here. We highly recommend downloading from GitHub, as it will be a more recent, and as a result better, version.

Pre-installations for Protocat

Python and Pip

  1. Run the Python 3.4.3 installer from here
  2. Make sure Add Python to PATH is enabled
  3. Newer releases of Python come with Pip pre-installed

Django

  1. Open Command Prompt(Windows) or Terminal (Mac)
  2. Use "pip install django" to install the main Django packages
  3. Other necessary installations
    • Type "pip install django-nose" into the prompt
    • Type "pip install coverage" into the prompt
    • Type "pip install django-contrib-comments" into the prompt
    • Type "pip install pytz" into the prompt
    • Type "pip install docutils" into the prompt

Github

  1. Install Github from here
  2. Be sure to select your operating system for the download
  3. Make sure Github has access to PATH

Running Protocat

  1. Copy the SSH URL from https://github.com/igemsoftware/Michigan15
  2. Inside Command Prompt or Terminal, cd into the directory you want the Michigan15 source file to be in
  3. Type "git clone [the SSH URL]" into the terminal
  4. cd Michigan15/mibiosoft
  5. To run, use "python manage.py runserver" and type the server address into your web browser
  6. Enjoy using Protocat 2.0!