Merging develop into main

Author: EnderHubris

.gitignore

@@ -0,0 +1,21 @@
+/node_modules
+/.pnp
+.pnp.js
+
+/coverage
+/build
+/docker/resumes
+
+backend/challenge_archives/*.zip
+
+.DS_Store
+.env
+.env.*
+/docker/.env
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+*.ps1
+*.bat

README.md

@@ -1,2 +1,42 @@
-# kent-hack-it
+# Kent-Hack-It
 Website repo for the Kent Hack It CTF
+
+## What is this?
+The frontend uses ReactJS that communicates to a ExpressJS backend that handles: user login/registration, team creation/joining, and flag submission.
+
+## :computer: Development Installation
+### :hammer: Install Dependencies
+```bash
+# if you do not have NodeJS installed
+sudo apt update && sudo apt install nodejs npm
+```
+
+### :wrench: Build
+```bash
+# installs dependencies/packages tracked by this project
+npm install .
+# compile and run the frontend locally
+npm start
+```
+
+Move the web related `.env` file into the project root directory, then run the following to run the backend locally.
+```bash
+nodejs backend/server.mjs
+```
+
+## :chart_with_upwards_trend: Production
+This project uses Docker :whale: for production set-up
+```bash
+sudo apt update && sudo apt install docker.io docker-compose
+```
+The following commands will build the docker via compose which builds the multi-docker system.
+You will need to move the `.env` into the project root folder before running the following:
+```bash
+docker network create traefik
+docker-compose --env-file .env -p khi -f docker/docker-compose.yml up --build
+```
+The following commands will build ONLY the khi website docker image that you later start via `docker run -d ...`.
+```bash
+docker build -f docker/Dockerfile -t image_name .
+docker run -d -p 8080:80 --name docker_name image_name
+```

backend/challenge_archives/README.txt

@@ -0,0 +1,2 @@
+Place your challenges archives here for players to download them for their associated challenges!
+To attach an archive to a challenge, simply write the URL in the challenge description.