README.md

Welcome To My Website!

As you are looking at the README, I imagine you must be interested in a tour...

To Download

I recommend using Git to download this repository, but if you'd like, you can also click here to get a zip file of the code.

Required to Run (Locally)

• NodeJS -- I use this only because of the self-referential nature of the app. Take a look at the guide to see why this is neccesary.
• An up-to-date browser -- if you're using Internet Explorer, I can't help you. Go here for salvation.

Required to Build (Locally)

• Python3 -- Anaconda -- I use this Python because it comes built in with the latest pip and because smarter people than I like it as well.

To Run (Locally)

cd path/to/directory
npm install
node index.js # starts local server at port: 3000

To Build (Locally)

python build.py

or if that doesn't work

python3 build.py

How It Works

1. The main information on the page is all in the src directory
2. The main build scripts are in the the src directory too
3. build.py will use multiprocessing to call all the build scripts at the same time using some import magic.
4. The build scripts will make the HTML files that are each of the views.
5. These HTML files are then inserted via JavaScript into their predetermined positions.
   1. NOTE: This is the reason I used NodeJS: in order to make an app that can "include" files locally (as there is nothing serving these files), one must serve them so that the browser isn't asking a filesystem for the resources but rather requesting a server. This is known as CORS Policy.