cold/INSTALL.html at main · caltechlibrary/cold · GitHub

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
<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>cold</title>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
    <link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
    <li><a href="/">Home</a></li>
    <li><a href="index.html">README</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <li><a href="about.html">About</a></li>
    <li><a href="search.html">Search</a></li>
    <li><a href="https://github.com/caltechlibrary/cold">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="installation-for-development-of-cold">Installation for
development of <strong>cold</strong></h1>
<p><strong>cold</strong> Caltech Library maintains a list of people,
groups and funders and their related identifiers. For many years these
were managed using a spreadsheets. That has become cumbersome.
<strong>COLD</strong> manages data as JSON objects in <a
href="https://github.com/caltechlibrary/dataset">dataset</a>
collections.</p>
<p><strong>COLD</strong> is implemented as three web web services</p>
<ul>
<li>cold web UI</li>
<li>cold JSON API (provided by datasetd)</li>
<li>cold reports (the report request system)</li>
</ul>
<p>Reports are implemented as a set of programs or bash scripts.</p>
<p>TypeScript+Deno is used to implement the web UI and report system.
The JSON API is provided by Dataset’s datasetd. Access control is
provided by the front end web server integrated with Shibboleth.</p>
<h2 id="quick-install-with-curl-or-irm">Quick install with curl or
irm</h2>
<p>There is an experimental installer.sh script that can be run with the
following command to install latest table release. This may work for
macOS, Linux and if you’re using Windows with the Unix subsystem. This
would be run from your shell (e.g. Terminal on macOS).</p>
<pre class="shell"><code>curl https://caltechlibrary.github.io/cold/installer.sh | sh</code></pre>
<p>This will install the programs included in cold in your
<code>$HOME/bin</code> directory.</p>
<p>If you are running Windows 10 or 11 use the Powershell command
below.</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode ps1"><code class="sourceCode powershell"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">irm</span> https<span class="op">://</span>caltechlibrary<span class="op">.</span><span class="fu">github</span><span class="op">.</span><span class="fu">io</span><span class="op">/</span>cold<span class="op">/</span>installer<span class="op">.</span><span class="fu">ps1</span> <span class="op">|</span> <span class="fu">iex</span></span></code></pre></div>
<h3 id="if-your-are-running-macos-or-windows">If your are running macOS
or Windows</h3>
<p>You may get security warnings if you are using macOS or Windows. See
the notes for the specific operating system you’re using to fix
issues.</p>
<ul>
<li><a href="INSTALL_NOTES_macOS.html">INSTALL_NOTES_macOS.md</a></li>
<li><a
href="INSTALL_NOTES_Windows.html">INSTALL_NOTES_Windows.md</a></li>
</ul>
<h2 id="installing-from-source">Installing from source</h2>
<h3 id="required-software">Required software</h3>
<ul>
<li>Deno &gt;= 2.7.5</li>
<li>Dataset = 2.3.4</li>
<li>CMTools &gt;= 0.0.40</li>
</ul>
<h3 id="steps">Steps</h3>
<ol type="1">
<li>git clone https://github.com/caltechlibrary/cold</li>
<li>Change directory into the <code>cold</code> directory</li>
<li>Make to build, test and install</li>
</ol>
<pre class="shell"><code>git clone https://github.com/caltechlibrary/cold
cd cold
make
make test
make install</code></pre>
</section>
<footer-global></footer-global>
</body>
</html>