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

add documentation for windows hosts

Browse Source
This commit is contained in:
Aidan 2024-11-07 18:58:04 -05:00
parent 83660d4438
commit 6205841264
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -30,7 +30,24 @@ Please note the /status endpoint will be broken with the original servers as COR
A server will now start on port :5566, and be accessible from your web browser at http://localhost:5566/. I highly suggest creating a NGINX reverse proxy for this, especially if you plan to point this to a domain.
## Windows
Windows is currently not supported by aidxnFUN yet. I suggest you use WSL, and follow the Ubuntu instructions, or purchase a VPS.
Windows support is still in the works, however it is possible to run aidxnFUN under Windows.
1. Install NodeJS and NPM for Windows from [nodejs.org](https://nodejs.org/)
2. Open a Node.js command prompt
3. Clone the repo
```bat
git clone https://github.com/ihatenodejs/aidxnFUN
cd aidxnFUN
```
4. Build the app
```bat
npm run winbuild
```
5. Run the app on port 5566
You may use the `PORT` variable to set a custom port. While Windows tends to default to 3000, we will use 5566, which is the default for aidxnFUN on Linux.
```bat
set PORT=5566 && node app.js
```
# How it works
This website uses Node.js, Express.js for a server, EJS for templating, and Tailwind CSS for the frontend CSS.