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

Line 3: Line 3:
  
 
<h2>Design</h2>
 
<h2>Design</h2>
−
<p>We used a Python package called Django as a web framework to aid in the web development and management of back end database. Django creates and maintains our database using a Model-View-Controller (MVC) system. To create the database we created a "class Protocol," the model of a protocol for our database. Attributes in our Protocol class are properties associated with a protocol, such as name, reagents, and steps. We then migrate these models through Django which creates our database for us. Whenever we want to make changes to our models, all we have to do is migrate the changes through Django which will change our database accordingly. Django comes with its own user system, so there is no need for us to make a user model.</p>
+
<p>HTML + CSS + Javascript were used to create the user interface for Protocat. The intent was to make and arrange the site in a way that is intuitive for users to create, find, and use any protocol on our database. We used Bootstrap for its HTML grid layout to format our pages.</p>
 +
 
 +
<p>On our backend, we used the Django web framework. Django is written in Python (we used Python 3.4). Django is a convenient framework to use because it is able manage administration, databases, authentication, templating data on HTML pages, and many other useful features. It is also fairly simple to learn because of it's Model-View-Controller (MVC) system. To create the database we created a "class Protocol," the model of a protocol for our database. Attributes in our Protocol class are properties associated with a protocol, such as name, reagents, and steps. We then migrate these models through Django which creates our database for us. Whenever we want to make changes to our models, all we have to do is migrate the changes through Django which will change our database accordingly. Django comes with its own user system, so there is no need for us to make a user model.</p>
  
 
<p>We have two databases, one for protocols and one for users. When someone signs up for Protocat, their username, email, password, first, and last name are added to the user database. Likewise, when someone uploads a protocol, all attributes of the protocol are saved into the protocol database.</p>
 
<p>We have two databases, one for protocols and one for users. When someone signs up for Protocat, their username, email, password, first, and last name are added to the user database. Likewise, when someone uploads a protocol, all attributes of the protocol are saved into the protocol database.</p>

Revision as of 21:08, 11 September 2015


Michigan Software 2015

Design

HTML + CSS + Javascript were used to create the user interface for Protocat. The intent was to make and arrange the site in a way that is intuitive for users to create, find, and use any protocol on our database. We used Bootstrap for its HTML grid layout to format our pages.

On our backend, we used the Django web framework. Django is written in Python (we used Python 3.4). Django is a convenient framework to use because it is able manage administration, databases, authentication, templating data on HTML pages, and many other useful features. It is also fairly simple to learn because of it's Model-View-Controller (MVC) system. To create the database we created a "class Protocol," the model of a protocol for our database. Attributes in our Protocol class are properties associated with a protocol, such as name, reagents, and steps. We then migrate these models through Django which creates our database for us. Whenever we want to make changes to our models, all we have to do is migrate the changes through Django which will change our database accordingly. Django comes with its own user system, so there is no need for us to make a user model.

We have two databases, one for protocols and one for users. When someone signs up for Protocat, their username, email, password, first, and last name are added to the user database. Likewise, when someone uploads a protocol, all attributes of the protocol are saved into the protocol database.

When uploading a protocol, the author is automatically chosen to be the username name of the uploader, taken from the user database. Each uploaded protocol is also given an auto-incremented id number. This id is used when making queries to the database to view a protocol, and helps differentiate protocol with the same name.

Uploading protocols and signing up for Protocat is the Controller in the MVC system because this is how we allow users to interact with the database. When people view protocols from the database is where the View comes in to play.

What should this page contain?
By talking about your design work on this page, there is one medal criterion that you can attempt to meet, and one award that you can apply for. If your team is going for a gold medal by building a functional prototype, you should tell us what you did on this page. If you are going for the Applied Design award, you should also complete this page and tell us what you did.

Note

In order to be considered for the Best Applied Design award and/or the functional prototype gold medal criterion, you must fill out this page.

This is a prize for the team that has developed a synthetic biology product to solve a real world problem in the most elegant way. The students will have considered how well the product addresses the problem versus other potential solutions, how the product integrates or disrupts other products and processes, and how its lifecycle can more broadly impact our lives and environments in positive and negative ways.

If you are working on art and design as your main project, please join the art and design track. If you are integrating art and design into the core of your main project, please apply for the award by completing this page.