aidan/aidxnFUN
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

add install section, cleanup

Browse Source
This commit is contained in:
Aidan 2024-10-13 11:31:10 -04:00 committed by GitHub
parent cb59b94504
commit 998949b0d1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -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. 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 # Using the `manage` script
You may have noticed you have a `manage` file after cloning. 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. `manage` is a command-line tool to manage the server. It can automatically start, stop, and restart your instance.