rishinair11 / one-word-story

A small game where participants create randomized one word stories, powered by Socket.io

One Word Story

Description

One word story is a small browser-based game where participants create randomized one word stories.

Players are connected using Socket.io

Setup

Project structure looks like this:

$ > tree -d -L 2
.
├── README.md
├── client
│   ├── README.md
│   ├── node_modules
│   ├── package-lock.json
│   ├── package.json
│   ├── public
│   └── src
└── server
    ├── app.js
    ├── node_modules
    ├── package-lock.json
    └── package.json

• client

cd client
npm i
npm start

• server

cd server
npm i
nodemon app.js

For Docker container deployment

In the project root directory, run:

docker-compose up -d

This will spin up a container each of the client (UI) and the server.

Public Dockerhub images:

• Client
• Server

For local Docker image builds, run:

cd client/
docker build -t one-word-story-client .
docker run one-word-story-client

for the client and likewise, for server.