Difference between revisions of "Introduction to Research Engineering"

From crowdresearch
Jump to: navigation, search
(Documentation and Specifications)
(Documentation and specifications)
Line 1: Line 1:
 
Welcome! This page offers a guide and some helpful tips to begin contributing to our research engineering efforts. We assume some preparation in computer science, in particular web programming, and a desire to learn and work hard. The following milestones outline a path to gaining familiarity with our codebase and will empower you to start making code contributions.
 
Welcome! This page offers a guide and some helpful tips to begin contributing to our research engineering efforts. We assume some preparation in computer science, in particular web programming, and a desire to learn and work hard. The following milestones outline a path to gaining familiarity with our codebase and will empower you to start making code contributions.
  
==Documentation and specifications==
+
==Documentation and Specifications==
 
*[https://git-scm.com/documentation Git]
 
*[https://git-scm.com/documentation Git]
 
*[http://www.postgresql.org/ Postgres]
 
*[http://www.postgresql.org/ Postgres]

Revision as of 15:41, 3 January 2016

Welcome! This page offers a guide and some helpful tips to begin contributing to our research engineering efforts. We assume some preparation in computer science, in particular web programming, and a desire to learn and work hard. The following milestones outline a path to gaining familiarity with our codebase and will empower you to start making code contributions.

Documentation and Specifications

Tutorials

  • <insert angular tutorial>
  • <insert django tutorial>
  • SQL

Milestone 0: The Basics

Before you being working on Daemo, we assume the following:

  • You have a Github account and understand pulling, pushing, forking, etc.
  • You have Postgres installed on your machine.
  • You have some familiarity with pip.

Milestone 1: Learning our Stack

Time to dust off your web programming skills (or pick up a few new ones).

If you are interested only in frontend work, you will need to be strong in HTML, CSS, and AngularJS. And most importantly be very familiar with Material Design. We assume you already know pretty everything you need to know or can figure it out when it comes to HTML and CSS. For those new to AngularJS we recommend the following (link here)tutorials and reading/playing with some of the templates and js files in our codebase. You will be using Angular Material components so give that page a close read as well as the Material Design spec.

If you are interested in backend work, you will need to be strong in Django and SQL.

Milestone 2: Getting Setup Locally

Go to our repo and follow the instructions in the README.

Milestone 3: Playing around Locally

Milestone 4: Issues and Pull Requests

Watch our short screenshare for a very simple approach to solving issues and creating a PR.