mirror of
https://github.com/Febbweiss/febbweiss.github.io.git
synced 2026-03-04 22:25:43 +00:00
342 lines
9.9 KiB
HTML
342 lines
9.9 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
|
|
<title>Cloudbudget - Febbweiss</title>
|
|
|
|
|
|
<link rel="shortcut icon" href="../../img/favicon.ico">
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../css/highlight.css">
|
|
<link href="../../extra/css/extra.css" rel="stylesheet">
|
|
<link href="../../extra/css/sis.css" rel="stylesheet">
|
|
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Cloudbudget";
|
|
var mkdocs_page_input_path = "development/cloudbudget.md";
|
|
var mkdocs_page_url = "/development/cloudbudget/";
|
|
</script>
|
|
|
|
<script src="../../js/jquery-2.1.1.min.js"></script>
|
|
<script src="../../js/modernizr-2.8.3.min.js"></script>
|
|
<script type="text/javascript" src="../../js/highlight.pack.js"></script>
|
|
<script src="../../js/theme.js"></script>
|
|
<script src="../../extra/js/pacman.js"></script>
|
|
<script src="../../extra/js/pyramid.js"></script>
|
|
<script src="../../extra/js/sis.js"></script>
|
|
<script src="../../extra/js/yahtzee.js"></script>
|
|
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href="../.." class="icon icon-home"> Febbweiss</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
<li>
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../..">Home</a>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<li>
|
|
<ul class="subnav">
|
|
<li><span>Development</span></li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href="./">Cloudbudget</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l3"><a href="#introduction">Introduction</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#requirements">Requirements</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#features">Features</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#usage">Usage</a></li>
|
|
|
|
<li><a class="toctree-l4" href="#api-documentation">API documentation</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../cloudbudget_angularjs/">Cloudbudget angularjs</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../filebrowser_durandal_widget/">Filebrowser durandal widget</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../project_deployer/">Project deployer</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../scrabble_resolver/">Scrabble resolver</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../springboot_react_webpack/">Springboot react webpack</a>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
<li>
|
|
|
|
<li>
|
|
<ul class="subnav">
|
|
<li><span>Docker</span></li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../docker/docker_apache_log_generator/">Docker apache log generator</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../docker/docker_gocd/">Docker gocd</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../docker/docker_java_log_generator/">Docker java log generator</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../docker/docker_log_centralizer/">Docker log centralizer</a>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
<li>
|
|
|
|
<li>
|
|
<ul class="subnav">
|
|
<li><span>Games</span></li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../games/Space_invaders_stories/">Space invaders stories</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../games/pacman/">Pacman</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../games/pyramid/">Pyramid</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../games/wordfighters/">Wordfighters</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../../games/yahtzee/">Yahtzee</a>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
<li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../..">Febbweiss</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../..">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>Development »</li>
|
|
|
|
|
|
|
|
<li>Cloudbudget</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/febbweiss/" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="introduction">Introduction <a href="https://travis-ci.org/Febbweiss/CloudBudget"><img alt="Build Status" src="https://travis-ci.org/Febbweiss/CloudBudget.svg?branch=master" /></a> <a href="https://coveralls.io/github/Febbweiss/CloudBudget?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/Febbweiss/CloudBudget/badge.svg?branch=master&service=github" /></a></h1>
|
|
<p>Cloudbudget is a work-in-progress online Money-like application.</p>
|
|
<p>It's written using ExpressJS and provided only REST services. The web interface is in a different project <a href="../../development/cloudbudget_angularjs">CloudBugdet-AngularJS</a>.</p>
|
|
<h2 id="requirements">Requirements</h2>
|
|
<p>CloudBudget needs a Mongo database. Database configuration is done in the <em>config/db.js</em> file.</p>
|
|
<p>The environment mode is defined by the environment variable NODE_ENV.</p>
|
|
<h2 id="features">Features</h2>
|
|
<p>The following features are developed:</p>
|
|
<ul>
|
|
<li>API security done with JWT</li>
|
|
<li>API documentation</li>
|
|
<li>User log on / log in</li>
|
|
<li>User deregistration</li>
|
|
<li>Bank account CRUD</li>
|
|
<li>Bank accounts listing</li>
|
|
<li>Deposit / Bill entry CRUD</li>
|
|
<li>Deposit / Bill entries listing</li>
|
|
</ul>
|
|
<h2 id="usage">Usage</h2>
|
|
<p>To initialize the application, install all dependencies with</p>
|
|
<pre><code>npm install
|
|
</code></pre>
|
|
|
|
<p>To launch CloudBudget, use the following command :</p>
|
|
<pre><code>NODE_ENV=development node app.js
|
|
</code></pre>
|
|
|
|
<p>If the PORT environment variable is set, it will be used, if not, the default port is 3000.
|
|
The server configuration is done with the <em>config/server.js</em> file.</p>
|
|
<h2 id="api-documentation">API documentation</h2>
|
|
<p>The root URL is linked to the API documentation.
|
|
The API documentation is generated with apidocs into the <em>public</em> folder. To generate it, use the following command :</p>
|
|
<pre><code>npm run-script generate-doc
|
|
</code></pre>
|
|
|
|
<p><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.0/gh-fork-ribbon.min.css" />
|
|
<!--[if lt IE 9]>
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.0/gh-fork-ribbon.ie.min.css" />
|
|
<![endif]-->
|
|
<a class="github-fork-ribbon" href="https://github.com/Febbweiss/CloudBudget" target="_blank" title="Fork me on GitHub">Fork me on GitHub</a></p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../cloudbudget_angularjs/" class="btn btn-neutral float-right" title="Cloudbudget angularjs">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../.." class="btn btn-neutral" title="Home"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a href="https://github.com/febbweiss/" class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
|
|
<span><a href="../.." style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="../cloudbudget_angularjs/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|