mayth/parasol

View on GitHub
doc/file.README.html

Summary

Maintainability
Test Coverage
<!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" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
  File: README
  
    &mdash; Documentation by YARD 0.8.7.3
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '';
  framesUrl = "frames.html#!" + escape(window.location.href);
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div id="header">
      <div id="menu">
  
    <a href="_index.html">Index</a> &raquo; 
    <span class="title">File: README</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><div id='filecontents'><h1>parasol</h1>

<p>CAPTURE THE FUTURE.</p>

<h1>Requirements</h1>

<ul>
<li>Ruby 2.1</li>
<li>PostgreSQL 9.3</li>
<li>Bundler</li>
</ul>

<h1>Setup</h1>

<ol>
<li>Clone this repository.</li>
<li>Create database user (role) on PostgreSQL. The user name is <code>parasol</code> by default (it can be changed by modifying <code>database.yml</code>). Note that the user should be able to create databases (CREATEDB). If not, you must create databases by your hand.</li>
<li>Remove <code>config/initializers/default_settings.rb</code> temporally.</li>
<li>Run <code>rake db:create</code></li>
<li>Check the database. There will be <code>parasol_{development,test}</code>. In addition, if you want to run this server in a production environment, you must create a database named <code>parasol_production</code>.</li>
<li>Run <code>rake db:migrate</code></li>
<li>Run <code>git checkout config/initializers/default_settings.rb</code> to restore the file removed in step 3.</li>
<li>Run <code>rails s</code>. Enjoy!</li>
</ol>

<h1>License</h1>

<p>This program is licensed under the MIT License. See <code>LICENSE</code>.</p>

<h1>Copyright</h1>

<p>Copyright (c) 2014 Mei Akizuru</p>

<h1>Contact</h1>

<ul>
<li>Edit wiki</li>
<li>Create issues</li>
<li>Create pull-req</li>
<li>Twitter(<a href="https://twitter.com/maytheplic">@maytheplic</a>)</li>
</ul>
</div></div>

    <div id="footer">
  Generated on Mon Apr 14 14:11:31 2014 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.7.3 (ruby-2.1.1).
</div>

  </body>
</html>