forked from GSA/srt-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
112 lines (74 loc) · 5.1 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><h1>srt-server</h1><p><a href="https://gitlab.tcg.com/acrowley/srt-server/commits/master"><img src="https://gitlab.tcg.com/acrowley/srt-server/badges/master/pipeline.svg" alt="pipeline status"></a>
<a href="https://gitlab.tcg.com/acrowley/srt-server/commits/master"><img src="https://gitlab.tcg.com/acrowley/srt-server/badges/master/coverage.svg" alt="coverage report"></a></p>
<p>The srt-server application is an expressjs Node application that provides a
REST API for the srt-client. Together the client/server provide a web portal
to view reports from and provide feedback to the Solicitation Review Tool (SRT).</p>
<h2>Deployment</h2><p>This web application is intended for deployment to cloud.gov. Deployment is
most easily performed using the deploy.sh script which will baseline, build,
deploy, and configure the SRT application. In the most simple case of deploying
a previously baselined version of the application to the staging space on
cloud.gov:</p>
<pre class="prettyprint source"><code>deploy.sh staging v1.4.0</code></pre><p>The full list of options available during deployment are:</p>
<pre class="prettyprint source"><code>usage: deploy.sh [OPTIONS] <SPACE> <TAG>
-d --dry-run : do everything but push to cloud.gov
-s --serverrepo : URI for srt-server repository
-c --clientrepo : URI for srt-client repository
-t --tempdir : defaults to /tmp
-y --yes : delete existing git repo in temp directory
-n --no : do not delete any existing git repo in temp directory
-b --create-tag-from-branch : Create TAG at head of this branch</code></pre><h2>Documentation</h2><p>Documentation for the srt-server is created from JSDoc tags embeded in the
source code. You can find a pre-build copy in the the <a href="docs/index.html">/docs</a>
directory of this repository. The documentaiton can be rebuilt from
source when updats are necessary using <code>npm run doc</code></p>
<h2>Running / Configuration</h2><p>The <code>npm run start</code> command will start the server. Configuration options are
read from the server/config/config.json file. config.json holds the configuration
for every environment the app amy be run in and the specific configuration for
this run is chosen based on the NODE_ENV environment variable.</p>
<p>Database connection information is stored in the config.json file but will be
overridden by any settings in the VCAP_SERVICES environment variable. This feature
allows cloud.gov to inject the proper database connection information upon
startup.</p>
<h2>Testing and Continuous Integration</h2><p>The srt-server application has a set of unit test in the server/tests directory.
These can be run from the command line with <code>npm run test</code> Database connection
are not mocked for the unit tests to ensure that data flows properly through
the system and into the database. </p>
<p>A test database file can be found in srt-database-export.sql.gz. There is a database
load process scripted in the <code>npm run restore-db</code> command. The package.json file has
connection information coded directly into that command. When running this for
the first time, that file will need to be updated to your local settings. </p>
<p>Continuous integration is configured in the .gilab-ci.yml file in the Gitlab format.
The CI server will start a Postgres database and load it with test data before
automatically running the unit tests.</p>
<p>A very brief Selenium IDE integration test can be found in the srt-client repository
under test/SRT.side. The integration test is not run automatically by the CI server.</p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-AgencyRoutes.html">AgencyRoutes</a></li><li><a href="module-AnalyticsRoutes.html">AnalyticsRoutes</a></li><li><a href="module-AuthRoutes.html">AuthRoutes</a></li><li><a href="module-EmailRoutes.html">EmailRoutes</a></li><li><a href="module-Models.html">Models</a></li><li><a href="module-PredictionRoutes.html">PredictionRoutes</a></li><li><a href="module-SolicitationRoutes.html">SolicitationRoutes</a></li><li><a href="module-SurveyRoutes.html">SurveyRoutes</a></li><li><a href="module-UserRoutes.html">UserRoutes</a></li><li><a href="module-VersionRoutes.html">VersionRoutes</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 08 2019 11:04:45 GMT-0500 (STD)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>