dev_getting_started.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Smeedee - A management tool for agile projects</title>
<link rel="stylesheet" type="text/css" href="css/styles.css" />


</head>

<body>
<div id="stripes"></div>
<div id="wrap">
    <div id="menu">
        <dl>
            
            <dt><a href="index.html">Home</a></dt>
            <dt><a href="doc_screenshots.html">Screenshots</a></dt>
            <dt><a href="download.html">Download</a></dt>
            <dt><a href="doc_faq.html">FAQ</a></dt>
            <dt><a href="doc_start.html">Documentation</a></dt>
            <dt><a href="doc_contact.html">Contact</a></dt>

        </dl>
        <div id="logo"></div>
    </div>
    

    <div id="illustration">
        

    </div>
    

    <div id="textbox">
        
        <div id="top">
            <b class="b5"></b>
            <b class="b4"></b>
            <b class="b3"></b>
            <b class="b2"></b>
            <b class="b1"></b>
        </div>
        <div id="bot">
            <b class="b1"></b>
            <b class="b2"></b>
            <b class="b3"></b>
            <b class="b4"></b>
            <b class="b5"></b>
        </div>


        <div id="textcontent">
        	
            <div class="contentRight">
                
    <h1>Documentation</h1>
    <ul>
        <li><a href="doc_faq.html">FAQ</a></li>
        <li><a href="doc_troubleshooting.html">Troubleshooting</a></li>
    </ul>
    <h1>For contributors</h1>
    <ul>
        <li><a href="dev_getting_started.html">Getting started</a></li>
        <li><a href="dev_detailed_intro.html">Detailed introduction</a></li>
        <li><a href="dev_architecture_overview.html">Architecture overview</a></li>
    </ul> 

            </div>
            <div class="contentLeft">
                

<h1>Getting started</h1>
<p>
Our Getting Started guide is written with the aim to help new developers to quickly get started contributing through Smeedee development.
</p>

<h3>1. Set up your development environment</h3>
<p>
See <a href="doc_dev_tools.html">Development tools</a> for a list of what you
need.
</p>

<h3>2. Check out the source code</h3>
<p>
    We use SubVersion for Source Control Management. For Windows users a good
    client is TortoiseSVN, however, any client of your choice can be used.
</p>

<p>
    You can check out or Subversion repository from
    http://smeedee.googlecode.com/svn/trunk
</p>

<h4>3. Open the main solution</h4>
<p>
    In the checked out folder, you can find our project in the trunk/source
    folder. In this folder you will find the solution file Smeedee.sln which
    contains all the projects needed for Smeedee. Smeedee.Client.Web is the
    main entrance to the smeedee application and should be used as start up
    project.    
</p>

<h3>4. What you can expect to find in the solution</h3>
<p>
Smeedee's Visual Studio solution is segmented into the following parts:
</p>

<p>
<ul>
    <li><b>Buildscripts</b> contains the scripts necessary to build Smeedee,
    run tests and generate setup kits.</li>
    <li><b>Client</b> contains client specific parts such as the client
    application itself and the different widgets, all enforcing the MVVM
    pattern.</li>
    <li><b>Common</b> contains common framework across the application such as
    settings and configuration.</li>
    <li><b>DomainModel</b> contains the domain concepts that Smeedee's
    different tasks and widgets are based on.</li>
    <li><b>Scheduler/Tasks</b> contains the different tasks that are run server side such
    as those used for gathering data from third party systems as well as the
    system for scheduling and dispatch these tasks.</li>
</ul>
</p>

<p>
Most parts consists of three projects:
<ul>
    <li>1 project for production code</li>
    <li>1 silverlight project for the view</li>
    <li>1 project with tests</li>
</ul>
</p>

<h3>5. Testing</h3>
<p>
    We are doing Test Driven Development (TDD) and strongly encourage you to do the
    same as this will help make sure the source code easier to maintain as well as
    minimizing technical debt and acting as documentation.
</p>
<p>
    We are also using TinyBDD - A behaviour driven development (BDD) DSL for C#
    which is also test runner agnostic and lets you do BDD syntax while writing
    tests.
</p>

            </div>
            <div class="break"></div>    

        </div>
    </div>
    
    <div id="footer" style="color:#FFF" />

</div>

</body>
</html>