From 998949b0d12c6e3da3119a96006d8b56454982b9 Mon Sep 17 00:00:00 2001 From: Aidan Date: Sun, 13 Oct 2024 11:31:10 -0400 Subject: [PATCH] add install section, cleanup --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index aed5912..5ab6452 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,37 @@ This is a more modern version of design. This repo may be archived at times due to me not needing a new design or extra features. +# Install and self host +Have a weird obsession? Want a pre-built site you can use for free? Host aidxnFUN! +As the code is avaliable under the CC Zero license, which means you should feel free and encouraged to change content, design, whatever! +During this process, `screen`, `node` (20.08.0, + +## Debian/Ubuntu/Other Debian-based systems +1. Clone the repo + ```bash + git clone https://github.com/ihatenodejs/aidxnFUN + cd aidxnFUN + ``` +2. Setup `manage` + ```bash + ./manage setup + ``` +3. Start the server + ```bash + ./manage up + ``` + A server will now start on port :3000, and be accessable from your web browser at http://localhost:3000/ + +## Windows +Windows is currently not supported by aidxnFUN yet. I suggest you use WSL, and follow the Linux instructions, or purchase a server. + +# How it works +This website uses NodeJS, ExpressJS for a server, EJS for templating, and Tailwind CSS for the frontend CSS. +The `manage` script uses all of those tools to manage the server for you executes the repetitive tasks for you automatically. +The views contain both regular page shards (full HTML documents) and generic shards. I define a "shard" as an EJS template, and are put together into a pretty little website at the end. + +Thus far, shards are included for a music widget, the header, and the footer of the pages. + # Using the `manage` script You may have noticed you have a `manage` file after cloning. `manage` is a command-line tool to manage the server. It can automatically start, stop, and restart your instance.