style/wording changes, add todo item

This commit is contained in:
Aidan 2024-11-08 00:08:46 +00:00 committed by GitHub
parent ad7fec8f88
commit 79d9b3e2f0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,17 +1,16 @@
# aidxnFUN # aidxnFUN
[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](http://creativecommons.org/publicdomain/zero/1.0/)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fihatenodejs%2FaidxnFUN.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fihatenodejs%2FaidxnFUN?ref=badge_shield&issueType=license) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fihatenodejs%2FaidxnFUN.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fihatenodejs%2FaidxnFUN?ref=badge_shield&issueType=license)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fihatenodejs%2FaidxnFUN.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2Fihatenodejs%2FaidxnFUN?ref=badge_shield&issueType=security) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fihatenodejs%2FaidxnFUN.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2Fihatenodejs%2FaidxnFUN?ref=badge_shield&issueType=security)
Built with Tailwind CSS, EJS, Express.js, and Node.js for a backend for it all. The full code of my website, under the CC0-1.0 license (public domain). Built with Tailwind CSS, EJS, Express.js, and Node.js
This is a more modern version of design.
This project is released under the CC0-1.0 license. The code and content are in the public domain.
# Install and self-host # Install and self-host
Have a weird obsession? Want a pre-built site you can use for free? Host aidxnFUN! Have a weird obsession? Want a pre-built site you can use for free? Host aidxnFUN! As the code is available under the CC0-1.0 license, which means you should feel free and encouraged to change content, design, whatever!
As the code is available under the CC0-1.0 license, which means you should feel free and encouraged to change content, design, whatever!
During this process, `node` (20.08.0), `npm`, and `netcat` will be installed on your computer.
Please note the /status endpoint will be broken with the original servers as CORS is blocked on sites not requesting from my personal domain. During this process, `node` (20.08.0), `npm`, and `netcat` will be installed. If you use Windows, you must manually install NodeJS.
**Please note:** The /status endpoint will be broken with default servers (ones I own) as CORS will block requests not made from aidxn.fun
## Debian/Ubuntu/Other Debian-based systems ## Debian/Ubuntu/Other Debian-based systems
1. Clone the repo 1. Clone the repo
@ -51,7 +50,9 @@ Windows support is still in the works, however it is possible to run aidxnFUN un
# How it works # How it works
This website uses Node.js, Express.js for a server, EJS for templating, and Tailwind CSS for the frontend CSS. This website uses Node.js, Express.js 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 `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-ish pages) and generic shards (fragments of pages, widgets, etc.). I define a "shard" as an EJS template, which are pieced together into a pretty little website. The shards hold individual elements like music widgets, while a regular page shard is the page that contains the music widget, which the end user sees. This is helpful for understanding the code. The views contain both regular page shards (full-ish pages) and generic shards (fragments of pages, widgets, etc.). I define a "shard" as an EJS template, which are pieced together into a pretty little website. The shards hold individual elements like music widgets, while a regular page shard is the page that contains the music widget, which the end user sees. This is helpful for understanding the code.
Thus far, shards are included for a music widget, the header, and the footer of the pages. Thus far, shards are included for a music widget, the header, and the footer of the pages.
@ -59,31 +60,32 @@ Thus far, shards are included for a music widget, the header, and the footer of
Music (as featured on the home page) is fetched from an API (hosted on https://biancarosa.com.br), which I am in the process of setting up for myself. It works with a LastFM account (I linked this to my Spotify) and can track your live listening with amazing accuracy. The repo can be found at [biancarosa/lastfm-last-played](https://github.com/biancarosa/lastfm-last-played). Music (as featured on the home page) is fetched from an API (hosted on https://biancarosa.com.br), which I am in the process of setting up for myself. It works with a LastFM account (I linked this to my Spotify) and can track your live listening with amazing accuracy. The repo can be found at [biancarosa/lastfm-last-played](https://github.com/biancarosa/lastfm-last-played).
# 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. This script only supports Linux-based systems.
`manage` is a command-line tool to manage the server. It can automatically start, stop, and restart your instance.
This script only supports Linux-based systems.
First, you must complete the setup with the following commands: First, you must complete the setup with the following commands:
```bash ```bash
chmod +x manage chmod +x manage
./manage setup ./manage setup
``` ```
After doing that, you are now ready to use the script. After doing that, you are now ready to use the script.
## `manage` usage ## `manage` usage
`./manage [command] [options]` `./manage [command] [options]`
## `manage` commands ## `manage` commands
+ `./manage up` - Builds the project and starts the server. + `./manage up` - Builds the project and starts the server
+ `./manage down` - Stops the server. + `./manage down` - Stops the server
+ `./manage restart` - Restarts the server. + `./manage restart` - Restarts the server
+ `./manage status, -s, --status` - Checks if the server is running. + `./manage status, -s, --status` - Checks if the server is running
+ `./manage help, -h, --help` - Shows the help message. + `./manage help, -h, --help` - Shows the help message
# Troubleshooting # Troubleshooting
I highly suggest you take a peek at the `node.log` file's contents. It's in the same directory as the `manage` script. This file contains the NodeJS server logs, which can be very helpful for debugging and/or troubleshooting. I highly suggest you take a peek at the `node.log` file's contents. It's in the same directory as the `manage` script. This file contains the NodeJS server logs, which can be very helpful for debugging and/or troubleshooting.
# To-Do # To-Do
- [ ] Implement PGP message verification - [ ] Implement PGP message verification
- [ ] Create `manage` script for Windows
- [X] Add menu link to tilde website - [X] Add menu link to tilde website
- [X] Update projects page to latest information - [X] Update projects page to latest information