Files
libreevent/website/dist/docs/contributing/packaging/index.html
2023-10-12 15:28:34 +02:00

37 lines
2.2 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>Packaging :: docs - libreevent</title>
<link rel="stylesheet" href="/docs/css/style.css">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8">
<meta name="description" content="Looking for a free and open source event management solution you can host yourself? libreevent is a project that does exactly that.">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/dark.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div id="nav"></div>
<div id="side-bar"></div>
<div id="backToTop" onclick="backToTop();"></div>
<div id="docPage">
<div id="doc-container">
<h1>Packaging</h1>
<p>libreevent has a very simple packaging script built in, it's called package.sh and can be run on any bash-compatible shell. This is another thing that should be improved: Add a batch script for the same purpose, it makes Windows user's life so much easier!</p>
<p>You can just run the script in a terminal by typing</p>
<pre><code>./package.sh
</code></pre>
<p>when in the main directory (Linux and MacOS only, requires installed Node.js and npm).</p>
<h1>Setting up the development environment</h1>
<p>To be able to work on libreevent, you need to have node.js and npm installed on your computer.</p>
<p>Then, to set up the development environment, run</p>
<pre><code>npm i
</code></pre>
<p>in the <em>src/server</em>, <em>src/webapp/main</em> and <em>src/webapp/setup</em> directories. This creates the <em>node_modules</em> folder in each of those directories. This is also what you need to do, if you want to upload the development version of libreevent.</p>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.1/jquery.min.js"></script>
<script src="/docs/js/index.js"></script>
</body>
</html>