Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
t41372 committed Dec 13, 2022
1 parent 6bb22d5 commit c705cf9
Showing 1 changed file with 24 additions and 15 deletions.
39 changes: 24 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
~~~~

0 comments on commit c705cf9

Please sign in to comment.