documented code

scripts/builder.js

@@ -1,3 +1,9 @@
+/*
+  This is a script that takes in the html, css & js to generate a single html string. 
+  It adds the CSS to a <style></style> tag, the JS to a <script type="module"></script> tag.
+  It then adds the links to the specified elements, hides the unselected ones, and returns the final string.
+*/
+
 const fs = require('fs');
 const { JSDOM } = require('jsdom');
 

scripts/screenshot.js

@@ -1,6 +1,6 @@
 /*
- During initial setup, run bun run puppeteer browsers install chrome,
- and copy the executable path to line 8
+    This script takes in as input a file that contains a HTML string, renders it in a browser instance, and takes two screenshots in different sizes.
+    During initial setup, run bun run puppeteer browsers install chrome, and copy the executable path to line 8
 */
 const puppeteer = require('puppeteer');
 

src/config.rs

@@ -27,6 +27,9 @@ impl Config {
     }
 }
 
+// Right now, this seems like the best way to manage the upload of templates from github
+// This function is very expensive, so a better method would be to write a dedicated endpoint for uploading templates from the site,
+// and adding it to the database along with it. But that's for another day.
 pub async fn monitor_templates_directory(app_state: Arc<AppState>) {
     let templates_dir = format!("{}/.zitefy/templates", env::var("HOME").unwrap());
 

src/handlers/user.rs

@@ -1,3 +1,6 @@
+// In this file, the logic should have existed in models/user.rs
+// in the heat of the moment, I've just gotten this to work.
+
 use actix_files::NamedFile;
 use actix_multipart::Multipart;
 use actix_web::http::Error;
@@ -236,6 +239,8 @@ async fn edit(
 ) -> impl Responder {
     let users: Collection<User> = app_state.db.collection("users");
 
+    // there might be a way to refactor this better. this line repeats everywhere
+    // get_user_id_from_token() was refactored, but i still think there's more room.
     let user_id = match get_user_id_from_token(&req, &app_state).await {
         Ok(id) => id,
         Err(response) => return response,

src/main.rs

@@ -23,6 +23,8 @@ use handlers::{user::LoginResponse, proxy_anthropic};
 use models::user::{EditData, LoginData, SignupData, UserDataResponse};
 use services::tempfiles::TempFileService;
 
+// this is very cumbersome, has to be changed.
+// right now, we don't have time to clean this up, but there should be a way.
 #[derive(OpenApi)]
 #[openapi(
     paths(

src/models/site.rs

@@ -62,6 +62,7 @@ pub struct Site {
     pub user: ObjectId,
 }
 
+// most of the names & code are self-explanatory. nothing much to document per se
 impl Site {
     pub async fn new(
         template_id: ObjectId,
@@ -351,6 +352,7 @@ pub fn read_dir_to_string(dir: &Path) -> io::Result<String> {
     Ok(contents)
 }
 
+// recursively reads the contents of a directory to filenames and returns them
 pub fn read_dir_to_names(dir: &Path) -> io::Result<Vec<String>> {
     let mut urls = Vec::new();
     for entry in fs::read_dir(dir)? {

src/models/template.rs

@@ -31,6 +31,7 @@ pub struct Template {
 }
 
 impl Template {
+    // add a template from metadata.json in the directory
     pub async fn from_metadata(path: &Path) -> Result<Template, Box<dyn std::error::Error>> {
         let metadata_path = path.join("metadata.json");
         let metadata_file = fs::File::open(metadata_path)?;
@@ -55,6 +56,7 @@ impl Template {
         })).await?)
     }
 
+    // build a site from a specified template
     pub async fn build_site(site_id: ObjectId, user_id: ObjectId, template_id: ObjectId, app_state: &Arc<AppState>) -> Result<PathBuf, Box<dyn std::error::Error>> {
         let home_dir = std::env::var("HOME")?;
         let site_dir = Path::new(&home_dir).join(".zitefy").join("sites").join(site_id.to_hex());
@@ -98,6 +100,7 @@ impl Template {
 
 }
 
+// copy everything from one dir to another
 fn copy_dir_all(src: &Path, dst: &Path, exclude: Option<&str>) -> io::Result<()> {
     if !dst.exists() {
         fs::create_dir_all(dst)?;
@@ -125,6 +128,7 @@ fn copy_dir_all(src: &Path, dst: &Path, exclude: Option<&str>) -> io::Result<()>
     Ok(())
 }
 
+// invoked by the background task to add a template to the db
 pub async fn update_template_in_db(path: &Path, app_state: &Arc<AppState>) -> Result<(), Box<dyn std::error::Error>> {
     let mut template = Template::from_metadata(path).await?;
     template.dir_path = path.to_string_lossy().to_string();
@@ -139,6 +143,7 @@ pub async fn update_template_in_db(path: &Path, app_state: &Arc<AppState>) -> Re
     Ok(())
 }
 
+// if ever we wanna implement deleting templates. code is redundant rn, so commenting to reduce build size.
 // pub async fn delete_template_from_db(path: &Path, app_state: &Arc<AppState>) -> Result<(), Box<dyn std::error::Error>> {
 //     let metadata_path = path.join("metadata.json");
 //     if metadata_path.exists() {

src/server/mod.rs

@@ -5,6 +5,9 @@ use std::{sync::Arc, env, path::PathBuf};
 
 use crate::models::user::User;
 
+// the server at zitefy.com
+// checks if a username matches one in the db & if it has an active site.
+// if so, serves the site, otherwise redirects to the portal
 pub async fn domain_server(
     app_state: web::Data<Arc<Database>>,
     req: HttpRequest,

src/services/preview.rs

@@ -13,6 +13,8 @@ pub struct Preview {
     pub desktop: PathBuf,
 }
 
+// if a path is provided, the preview images will be stored to that path, otherwise generates a temporarry file
+// useful for generating permenant and temporarry images (for template previews)
 pub async fn generate_preview(
     html: &str,
     paths: Option<Preview>,
@@ -55,6 +57,7 @@ pub async fn generate_preview(
     })
 }
 
+// just a wrapper around scripts/builder.js
 pub fn build_html_string(
     html: PathBuf,
     css: PathBuf,

src/services/tempfiles.rs

@@ -5,6 +5,7 @@ use uuid::Uuid;
 use std::path::PathBuf;
 use std::time::{SystemTime, UNIX_EPOCH};
 
+// basically just a setup to manage temporarry files, like preview images in the editor.
 pub struct TempFile {
     path: PathBuf,
     expiry: u64,