AvalonDocumentationEngine/views/articles/Installation.ejs

<p>Welcome to the ADE installation guide!</p>
<p>This guide will assist you while installing the Avalon Documentation Engine on a local server.</p>
<p>Make sure you have your 80 port open on this server.</p>
<%- include("blocks/MessageBox.ejs", {
  title: "Docker support",
  content: "This guide will not contain resources for installing ADE on Docker. You are purely on your own for that."
}) %>
<h1>Installing locally or on a Node server</h1>
<p>If you just want ADE for your local network, or on your own real server.</p>
<h2>Steps</h2>
<h3>Step 1 - Downloading the repository from GitHub</h3>
<p>First, go to any folder you would like to keep ADE in.</p>
<p>Then, go to <a href="https://github.com/MeowcaTheoRange/AvalonDocumentationEngine" target="_blank">the GitHub repository for ADE</a> and download the ZIP.</p>
<img src="/assets/github1.png" />
<small>Selecting Code > Download ZIP on the GitHub UI.</small>
<p>Then, extract the ZIP into the folder.</p>
<img src="/assets/extract1.png" />
<small>Dragging the ZIP contents into a folder.</small>
<%- include("blocks/MessageBox.ejs", {
  title: "HOLD ON...",
  content: "Make sure to read the license! This information is important for defining who and what can use the documentation contents.<br />Alternatively, make a \"License\" article within the Documentation to define your own license for the content.<br />Instructions on how to do this can be found <a href=\"/page/Licensing_documentation_content\">here.</a><img src='/assets/makesure1.png' />"
}) %>
<h3>Step 2 - Install dependencies</h3>
<p>Installing dependencies for the Avalon Documentation Engine is super easy. Simply open a Node terminal in your Documentation folder.</p>
<img src="/assets/terminal1.png" />
<small>A terminal, which has the documentation as its' current directory.</small>
<p>Then, type <code>npm install</code> (or <code>npm i</code>) into the terminal.</p>
<img src="/assets/npmi1.png" />
<small>A terminal, which has the output of the aforementioned npm command.</small>
<p><code>package-lock.json</code> and <code>node-modules/</code> should appear in the directory.</p>
<h1>Installing on Replit</h1>
<p>If you want quickly get ADE up and running.</p>
<%- include("blocks/MessageBox.ejs", {
  title: "Cycles required",
  content: "In order to use ADE on Replit, you will have to use Cycles to make your ADE Repl Always On.",
  notice: "2 cycles/day for Always On - recommended amount is 62, for at least a month"
}) %>