DGG Raffle Dashboard

This is repo to manage a webapp consisting of

• Static React Frontend
• Node Express JWT Authenticated Backend
  • Database in google sheets
  • Routinely scrapes Charity Donation list for new entries.
  • Simple auth free api intended for use in OBS overlays

The webapp is currently hosted on a ec2-aws instance with nginx configured with Cloudflare SSL certificate. The nginx will proxy any requests needed to the backend api server when needed, any request with root path /api

Database is here here (You need access.)

Up to date export of raw data is available here

Up to date export of Donation statistics found here

Configuration

Inital setup

prerequistes

• Ubuntu ec2 AWS instance \w putty connection (remember to open neccesary ports)
• github repo ( preferably precompiled build included, not server)
  • tip generate a github key which can be stored so you don't need password everytime.
• mongodb cluster, \w security configured to allow access from server host

Preparing Ubuntu instance

// update package list
sudo apt update

1- // this line installs curl on the Ubuntu server
$ sudo apt-get install curl
2- // this line downloads Node.js
$ curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -
3- // this line installs node
$ sudo apt-get install nodejs

// Store github credentials
git config --global credential.helper store
git config --global credential.https://github.com.%githubUsername% %githubAccessToken%

// clone production branch
git clone --branch production https://github.com/NickMarcha/NickMarchaPortfolio.git

the RaffleDashboard/server folder needs a `.env`` with you google service account and key configuration. As well as a JWT_SECRET

GOOGLE_SERVICE_ACCOUNT_EMAIL="[email protected]"
GOOGLE_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n your key here\n-----END PRIVATE KEY-----\n"
JWT_SECRET="your long personal password here"
HOST_URL="http://%Your Host IP%/"
DOMAIN_NAME="https://example.com/"

Preparing nginx (fuller guide here)

//make sure you are superuser for installs
sudo su
sudo apt install nginx
//Verify status
service nginx status
//start service
service nginx start

Remove default config and create your own

cd /etc/nginx/sites-enabled
rm default
nano client-config

My client-config

server {
    listen 443 ssl;
    server_name www.example.com;
    ssl_certificate /home/ubuntu/cert/cert.pem;
    ssl_certificate_key /home/ubuntu/cert/key.pem;

    location / {
        proxy_pass http://localhost:3000;
    }

    location /api {
        proxy_pass http://localhost:3001;
    }
}

The certificate referenced is an origin SSL provided by cloudflare it is stored in the root directory in /cert/ this enables cloudflare full proxy as well as https.

To get cors working be sure to change the accepted header urls in server/index.json

Running the Build

Go back inside the root folder RaffleDashboard run

npm run installAll

This should run npm install in root, client and server folders. running in the root folder enables easy start of server using concurrently.

Serving frontend & backend

npm run serve

This will serve both frontend and backend at the same time.

Tip

SHHing into your ubuntu instance the process will likely close as you end your session. Some helpull tmux commands to keep process running and reachable.

//create new session
tmux new -s webapp
//list sessions
tmux list-sessions
// Re enter session
tmux attach -t %sessionName%

You can now close your ssh session without shutting down you app.

Development

For development a nginx is not needed the React Development proxy is enough (already installed). it is sufficient to run the script npm run installAll in the root package.json.

setup the file server/.env with development credentials, you can copy from ./server/.env.copy

and run

npm run start

You should be able to see live changes in dev database

This will start the react development server in /client and in /server a nodemon instance.