Skip to content

React based wrapper around Songsterr; Supports embedding multiple Songsterr windows and synchronization accross the network

Notifications You must be signed in to change notification settings

HetorusNL/react-songsterr

Repository files navigation

React Songsterr and RS Online

React based wrapper around Songsterr: Supports embedding multiple Songsterr windows in a single browser window.
RS Online supports synchronization of songsterr interactions across the network.
React Songsterr with RS Online is hosted at: https://rs.hetorus.nl.
(The development server, if online and reachable, is hosted at: https://dev.rs.hetorus.nl).

Using this repository

Make sure to modify .env.development during development and .env.production when deploying your instance of React Songsterr and RS Online!

Currently, the development server is set to: https://dev.rs.hetorus.nl and the production server is set to: https://rs.hetorus.nl. The corresponding development/production server appended with /ws path is used for the RS Online Python3 script, so modify this as wel (also mentioned in chapter: Deploy the newly generated version to the server).

Scripts

Run the development server

run the following command to run the dev server:
yarn start
this starts the development server on localhost:3001

Run a build (without incrementing version number)

run the following command to build the application:
yarn build
this updates the version number (if changed in package.json) and builds the application

Run a build with version increment and git commit creation

the Semantic Versioning, also known as "semver", is used:
version: major.minor.patch
run one of the following commands:
yarn version --patch // increments the patch number of the version
yarn version --minor // increments the minor number of the version
yarn verison --major // increments the major number of the version
all these three commands also create a git commit and git tag with the message:
v${npm_package_version} (which is the major.minor.patch version)
these three commands also perform a push to the master branch on github and push the tags

Deploy the newly generated version to the server

prerequisites:

  • (windows only) the rs_online.py script should be stopped
  • (windows only) and the terminal running the script should be cd'd to the root dir

run the following command to deploy the new version:
yarn deploy
this removes the previous build from the server and copies the build including rs_online to the server
also the server's IP address is changed from development pc IP to server IP
(modify this script if a different IP address/subnet is used!)

postrequisites:

  • (windows only) cd the terminal back into the rs_online folder
  • (windows only) start the rs_online.py script: python3 rs_online.py
  • (linux only) restart the rs_online.py script: python3 rs_online.py

About

React based wrapper around Songsterr; Supports embedding multiple Songsterr windows and synchronization accross the network

Resources

Stars

Watchers

Forks

Packages

No packages published