Skip to content

ianarsenault/Pulse-Roshambo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pulse-Roshambo

Build Status

A Web App for Tier 3 members to roshambo over fixing bugs && production incidents

Alt Text

Table of Contents


Run Locally

Clone repo

git clone https://github.com/ianarsenault/Pulse-Roshambo.git

Run client

cd client
npm install
npm run dev

To run server locally:

First Install MongoDB if not already installed

To run it:

mongod

Next you will need to configure an env file

cp server/example.env server/.env

Open the newly created .env file and update the environment:

NODE_ENV="dev"

Now you're ready to run the server:

cd server
npm install
npm run dev

For PC

npm run dev:pc

Deployment

Follow these instructions to get mongodb setup on ubuntu https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/

You will need to first install forever to run the server

sudo npm install -g forever

The command to manually run the server using forever:

forever start ./server/bin/www

Deploy Script

There is a deploy.sh script in the root of the repo that will run the build for you and start the server.

In order to run the script you need to ensure it is executable:

chmod +x deploy.sh

What the Deploy Script does:

  • Pull the latest from git - (We may want to add an env variable that we can use to specify a branch in the future)
  • Run npm install and build the client
  • Create the directory for file uploads
  • Run npm install for the server
  • Trigger the forever command to keep the server running

Nginx config

Along with your other normal server config, you will want to point the server root at the client/dist directory:

server {
    listen 443 ssl http2;
    listen [::]:443 ssl http2;
    server_name roshambo.silucions.com;
    root /home/forge/roshambo.silucions.com/client/dist;
    ...

Setup a proxy for the api:

location /api {
    proxy_pass http://localhost:8081;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection 'upgrade';
    proxy_set_header Host $host;
    proxy_cache_bypass $http_upgrade;
}

Changelog

For changelogs, check out the Releases section of Roshmabo or the CHANGELOG.md.


Contributing

Open an issue or a pull request to suggest changes or additions.

Contributors

ianarsenault jaydeluca j-arsenault adigitalmonk jkeys QuestionMarks
ianarsenault jaydeluca j-arsenault adigitalmonk jkeys QuestionMarks