"
Team:Michigan Software/Protocat
From 2014.igem.org
(→User Guide) |
|||
| (50 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Template:Michigan_Software/NavBar}} | ||
| + | [[File:protocatbanner.jpg|center]] | ||
<html> | <html> | ||
| - | < | + | <FONT FACE="Segoe UI"> |
| - | < | + | </html> |
| - | < | + | ==Live Software== |
| + | These links will work at least for the remainder of 2014. If you'd like to set up your own server, check out the downloads section. | ||
| + | [http://141.214.65.144 Click here to go to ProtoCat!] | ||
| + | <html> | ||
| + | <!-- | ||
| + | <section class="loginform cf" > | ||
| + | <a href="http://127.0.0.1:8000/home"> Visit our Home Page </a> | ||
| + | <form name="login" action="index_submit" method="get" accept-charset="utf-8"> | ||
| + | |||
| + | <ul> | ||
| + | <li><label for="usermail">Email: </label> | ||
| + | <input type="email" name="usermail" placeholder="yourname@email.com" required></li> | ||
| + | <li><label for="password">Password: </label> | ||
| + | <input type="password" name="password" placeholder="password" required></li> | ||
| + | <li > | ||
| + | <input type="submit" value="Login"></li> | ||
| + | </ul> | ||
| + | </form> | ||
| + | </section> | ||
| + | --> | ||
| + | </html> | ||
| - | + | ==Download== | |
| + | You can download our project from [https://github.com/igemsoftware/Michigan14 our github] or [[Media:Project.zip|download the wiki freeze version here]]. We HIGHLY recommend downloading from GitHub, as it will be a more recent, and undoubtedly better, version. | ||
| - | + | ==Instructions== | |
| + | ===Installation=== | ||
| + | 1. If you're on a PC install [https://www.python.org/download/ Python]. We recommend Python 3.4 for compatibility with our package. | ||
| - | + | 2. Install [https://docs.djangoproject.com/en/dev/howto/windows/ Django]. | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | 3. Download and Unzip Protocat [https://github.com/igemsoftware/Michigan14 through Github] or [[Media:Project.zip|download the wiki freeze version here]]. | |
| - | + | 4. In the Command Prompt or Terminal, access the ProtoDB folder. | |
| - | </ | + | |
| + | 5. Enter "python manage.py syncdb". | ||
| + | |||
| + | 6. Enter "python manage.py runserver". | ||
| + | |||
| + | 7. Go to 127.0.0.1:8000/home in your web browser to begin! | ||
| + | |||
| + | N.B. When installing Django, don't forget to make sure the path is correct. | ||
| + | ===User Guide=== | ||
| + | Unzipping the folder will result in the following file structure:<br><br> | ||
| + | Michigan14-branch1\<br> | ||
| + | ProtoDB\<br> | ||
| + | ProtoDB\<br> | ||
| + | databasemodels\<br> | ||
| + | templates\<br> | ||
| + | <br><br> | ||
| + | |||
| + | The first ProtoDB file contains, along with all the other folders, manage.py. You need to be in this folder to run "runserver" or "syncdb".<br> | ||
| + | |||
| + | In order to create the database for first-time use, check models.py in the "databasemodels" folder. If you make alterations to this file, or just want run our implementation, navigate to Michigan14-branch1\ProtoDB in your command-line terminal and type "python manage.py syncdb". This will create/update the SQLite database.<br> | ||
| + | |||
| + | "ProtoDB" (the second one) contains the settings files and the URL file.<br> | ||
| + | |||
| + | urls.py houses all the url definitions. | ||
| + | settings.py is where you can change settings, add plugins or "installed_apps", and do some general tweaking. Please see Django documentation for more information. | ||
| + | |||
| + | "databasemodels" contains the bulk of the Protocat. | ||
| + | <br>models.py contains the database model definitions. <br> | ||
| + | <br>admin.py houses admin settings.<br> | ||
| + | <br>views.py contains most of the code that makes Django run. It contains functions, like the functions that allow protocol deletion and creation. It is linked to urls.py<br> | ||
| + | <br>forms.py contains HTML form class definitions. It allows Django to create HTML forms and use their data, linking HTML forms with the functions in views.py. Technically, the class definition can be anywhere, but it is convention to keep the in forms.py<br> | ||
| + | |||
| + | "templates" contains just that. HTML templates. Each page has its own templates. Modify HTML here. | ||
| + | |||
| + | [[Team:Michigan_Software/results|Here are some screenshots]] for guidance. | ||
| + | {{Template:Michigan_Software/Foot}} | ||
Latest revision as of 03:48, 18 October 2014
Contents |
Live Software
These links will work at least for the remainder of 2014. If you'd like to set up your own server, check out the downloads section. [http://141.214.65.144 Click here to go to ProtoCat!]
Download
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 undoubtedly better, version.
Instructions
Installation
1. If you're on a PC install Python. We recommend Python 3.4 for compatibility with our package.
2. Install Django.
3. Download and Unzip Protocat through Github or download the wiki freeze version here.
4. In the Command Prompt or Terminal, access the ProtoDB folder.
5. Enter "python manage.py syncdb".
6. Enter "python manage.py runserver".
7. Go to 127.0.0.1:8000/home in your web browser to begin!
N.B. When installing Django, don't forget to make sure the path is correct.
User Guide
Unzipping the folder will result in the following file structure:
Michigan14-branch1\
ProtoDB\
ProtoDB\
databasemodels\
templates\
The first ProtoDB file contains, along with all the other folders, manage.py. You need to be in this folder to run "runserver" or "syncdb".
In order to create the database for first-time use, check models.py in the "databasemodels" folder. If you make alterations to this file, or just want run our implementation, navigate to Michigan14-branch1\ProtoDB in your command-line terminal and type "python manage.py syncdb". This will create/update the SQLite database.
"ProtoDB" (the second one) contains the settings files and the URL file.
urls.py houses all the url definitions. settings.py is where you can change settings, add plugins or "installed_apps", and do some general tweaking. Please see Django documentation for more information.
"databasemodels" contains the bulk of the Protocat.
models.py contains the database model definitions.
admin.py houses admin settings.
views.py contains most of the code that makes Django run. It contains functions, like the functions that allow protocol deletion and creation. It is linked to urls.py
forms.py contains HTML form class definitions. It allows Django to create HTML forms and use their data, linking HTML forms with the functions in views.py. Technically, the class definition can be anywhere, but it is convention to keep the in forms.py
"templates" contains just that. HTML templates. Each page has its own templates. Modify HTML here.
Here are some screenshots for guidance.
