In /public-frontend, there is a Vite + Vue project that can operate in development server mode or leverage vite-ssg to pre-render plain HTML+CSS+JS for production.
In /staff-frontend, there is a minimal Next.js React project that can do the same things via built-in Next.js stuff.
In /global-includes, there are database model classes that Remult can use to automatically create database tables and an API that modifies them.
In /server, there is a server application that ties everything together. In dev mode, it creates Remult, Vite, and Next.js server middleware, and puts up the staff frontend at staff.localhost:3000 and the public frontend and Remult API at localhost:3000. Requests are routed seamlessly; the database API is globally available, but the sites are neatly separated.
Registrations are currently disabled in the code since the event is over. To re-enable them, simply undo the changes in commit 4a929dd789dd1fa88620b5498d14acdd9a38c663.
- Install Node.js, which will run our non-browser code.
- Open the root directory of this repository in your terminal.
- Install yarn, which will manage the site's libraries, tools, and dependencies, by running
npm install -g yarnin it. - Install those dependencies by running
yarn install.
If you just want to work on the appearance of the public frontend, you can stop there and run yarn serve-public to bring up a dev server for it and make changes and view them live by clicking the link that shows up in the terminal. If you want to work on stuff that involves the database or user accounts, you need to do a few more things:
- This site uses MongoDB to store data, so please download and install that. (The community edition is free and works perfectly.)
- Then, set up the URL localhost.khe.io by running
yarn acquire-urlsin this directory with root privileges; you'll have to run PowerShell as an administrator on Windows or use sudo on Linux. This command will set up "localhost.khe.io" and "staff.localhost.khe.io" to refer to your running instance of the web server on your computer only. - To log into sites and check users' credentials through Github and Discord, you need to create an OAuth app through each of their developer portals; or, just ask Mitch for the passwords for the apps that already exist for this. Maybe I should put them on Google Drive or Discord or something.
- Then, run the server with
yarn dev, and access the site through the links that will show up in the terminal.
To add code this project, create a branch and make changes in it; then, to deploy your changes to https://dev.khe.io, merge them into the "dev-main" branch. To deploy changes to the real website, open a pull request for the "production" branch.
The existing public site for KHE, which is written in Vue, is not in bad shape and mostly just needs a fresh coat of paint; so, I'm using it as a base with Vite as the build system responsible for it. The existing staff site for KHE is very old and written in AngularJS, so I think it should be mostly replaced with a Next.js project. Also, why not?
If you are new to this kind of project, kindly read the next 1,000,000 words of explanation in order to better understand the above.
is a language. Originally, JavaScript ran in web browsers to make simple changes to HTML web pages in response to visitor's actions. In the words of one of the relevant developers: "The by-design purpose of JavaScript was to make the monkey dance when you moused over it. Scripts were often a single line." Now, JavaScript generates most new pages on the Internet completely on its own.
First of all, JavaScript can run outside of the browser now. Node.js is a program that can run arbitrary JavaScript code wherever a normal program can be installed. Many web developers use this to write and run "backend" or "server-side" JavaScript code, which is code that will run on a server and do things the browser-side code cannot, like store and retrieve information from a centralized database. The code that actually runs in a user's browser to show them pictures and respond to button presses is called, in contrast, frontend code.
The typical modern frontend development process involves writing HTML-like templates and then feeding those templates into a JavaScript library like React or Vue. The templates become these things known as "components", which are reusable units of code that work kind of like functions in normal programming; they have variables, which make up what is known as the components' "state." The JavaScript library automatically fills in the templates by using the initial values of the variables used by the components. Then, it changes that state as needed by assigning new value to the variables in functions that run when users do things. Importantly, whenever the state variables are updated, the JavaScript library automatically updates the templates to match the current state.
Writing functions that directly modify HTML is kind of tricky a lot of the time; believe it or not, writing templates that use variables and then writing functions that modify those variables is actually easier; so that's where we are.
This is the loose code for a simple component written with the JavaScript library "React". Go here to see it run.
import React, { useState } from "react";
export default function MyComponent() {
// create component state variable called "greeting"; initialize it to the
// string "hello world":
const [greeting, setGreeting] = useState("hello world");
// create a function that will update oir state in response to user actions:
function leaveWorld() {
setGreeting("goodbye world");
}
// use these JavaScript things in an HTML-like template:
return (
<>
<p>{greeting}</p>
<button onClick={leaveWorld}>Say Goodbye</button>
</>
);
}This is the loose code that accomplishes the same thing with Vue. Go here to see it run.
<script setup>
import { ref } from "vue";
// create component state variable called "greeting"; initialize it to the
// string "hello world":
const greeting = ref("hello world");
// create a function that will update our state in response to user actions:
function leaveWorld() {
greeting.value = "goodbye world";
}
</script>
<template>
<!-- use these JavaScript things in an HTML-like template: -->
<p>{{ greeting }}</p>
<button :onClick="leaveWorld">Say Goodbye</button>
</template>You will notice that the comments in the two versions are identical. The two libraries accomplish very similar things. They used to be more different, but this is the latest method for defining components in each library.
Neither library's HTML-like template syntax is actualy valid JavaScript that web browsers can understand. Both of the above examples need to be compiled before browsers can understand them. There are many tools that are used to solve this problem, but the most recent fastest and buzziest top-level tool for accomplishing this is called Vite. There is also an older tool that is still very widely used called Webpack. Both of these programs have the ability to constantly re-compile and reload components in your browser as you develop them, as well as the ability to output a small, compressed, optimized JavaScript "bundle" (potentially containing many files combined into one) that, when you're done developing, can be served to browsers over the Internet at top speed.
This is how many Vue and React sites work: the developers write code using their favorite library; the compiler turns that code into valid browser-friendly JavaScript; and the browser runs that code to create pages when the user downloads it. Basically no actual HTML is sent to browsers; JavaScript runs to create and arrange everything on screen. Additionally, the same JavaScript will usually be sent to the browser no matter what page the visitor visits; the code has to detect the URL the browser has open and choose what page to render correspondingly. This is known as the SPA or single-page app approach, since there is effectively only one page; it's just being rendered in different ways by JavaScript and the browser, based on the user's actions and the current web address.
It is mean to not have HTML to send to browsers, and to make them do all that work themselves. It is also potentially quite slow, depending on the speed of your users' computers. It is also hard for search engines to figure out what search terms match your page when the page is blank when it initially loads and they have to run JavaScript to fill it in. Fortunately, as mentioned before, we have the ability to run JavaScript outside of the browser, thanks to Node.js. Running our frontend code in Node.js lets us turn it or some of it into real HTML before sending it to the browser, so the content loads more quickly and is understandable to search engines.
Next.js is a library for React that automatically turns React components into HTML web pages. It is currently occuping the /staff-frontend folder. You can put it in SPA mode, where all the page rendering is done on the frontend, but you can also use it for server-side rendering (SSR), where the React code is partially turned into HTML before it's sent to the browser, or static site generation (SSG), where the React code is completely turned into HTML files that can then be used however you want. Behind the scenes, Next.js uses Webpack.
Vite is the easiest way to render Vue sites like the existing old KHE public website that the new one is going to be based on. It creates SPA apps by default, but with the libraries vite-ssr and vite-ssg, it can also be made to do server-side rendering and static site generation.
The backend code is located in the /server directory. It starts up the Vite and Next.js servers, and sends browser requests that start with staff.[khe.io] to the Next.js server and the others to the Vite server. It also uses a backend library called Remult to create a database consisting of objects that follow the class specifications in the /global-includes directory. The database can then be accessed from the frontend by importing different Remult code and running it in the Vite and in the Next.js projects; doing this will cause the Remult code that should run on the frontend to send a request to the server that the Remult code running on the backend will respond to.
Currently, Remult just creates a JSON file in the db folder to serve as a simple database, but at some point we should make it instead save stuff in MongoDB so it can be faster.
The backend code is written in TypeScript, which is a version of JavaScript in which variables and objects are annotated with types. Without TypeScript, any variable can be any type and any object can have any member variables or member functions; this shouldn't be a big problem on the frontend, since there won't be a ton of variables or data, but on the backend, especially when interacting with databases, it is important to be clear about what data you are accepting and emitting. TypeScript needs to be compiled (technically, "transpiled") to regular JavaScript for Node.js to run it. Such is life.