From c705cf9648c474802a7079e0d520bfb0a73f40a5 Mon Sep 17 00:00:00 2001 From: Yi-Ting Chiu Date: Mon, 12 Dec 2022 18:38:42 -0800 Subject: [PATCH] Update README.md --- README.md | 39 ++++++++++++++++++++++++--------------- 1 file changed, 24 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 1b54132..5e0e259 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,33 @@ # QueueRoom +### What is this? +This is a full stack web application using Node.js, Express.js, SQLite, HTML, CSS, JavaScript, and Docker + +Build to help people queue online. Users can create or join a room to queue online with a generated password. + +RESTful API is provided. Docker image is built for speeding the deployment process. + -# Run +## Run ~~~ bash -#set up dependencies +# set up dependencies npm install -#run Queue Room +# run Queue Room node server.js +# the server will now be listening on 8080 (default) +~~~~ + +## Docker +[t41372/queue_room_docker](https://hub.docker.com/repository/docker/t41372/queue_room_docker) +### Build Docker Image from source code +~~~~ shell +docker build -t t41372/queue_room_docker:architecture . +~~~~ +### Run with Docker +~~~~ shell +# replace architecture with the cpu architecture of your machine... like x86_64 or arm64. Latest tag is an arm64 build +docker run -d -p 8080:8080 t41372/queue_room_docker:architecture +# -p (port you want it to listen on:8080) ~~~~ # Bug List @@ -23,15 +44,3 @@ Current Solution: ignore it. Make the background color the same black as other p ### Can't add people twice, or the server crash ~~who knows why...~~ Solved. (Dec 12, 2022) in server.js line 316, the `queryPromiseGet` function is mistakenly overriden, so after running `addPeople` function once, `queryPromiseGet` will not be a function anymore -# Docker Image -[t41372/queue_room_docker](https://hub.docker.com/repository/docker/t41372/queue_room_docker) - -### Build Docker Image -~~~~ shell -docker build -t t41372/queue_room_docker:architecture . -~~~~ -### Run with Docker -~~~~ shell -# replace architecture with the cpu architecture of your machine... like x86_64 or arm64. Latest tag is an arm64 build -docker run -d -p 8080:8080 t41372/queue_room_docker:architecture -~~~~ \ No newline at end of file