vizwall_screensaver/README.md

26 lines
960 B
Markdown
Raw Normal View History

2023-09-15 17:19:19 -04:00
# vizwall_screensaver
This is a screensaver for the Visualization Wall in ER 1431-03.
To implement on server: first, environment variables would need to be set in a .env file.
A .env.example file is supplied. The values will be supplied privately.
To start the webpage: first, clone the repo.
second, change your current working directory to the root of the repo.
third, run npm install.
finally, run npm start.
Alternatively, perhaps ideally, a process manager which can restart the node server on server reboot or crash would be implemented to run the server.
pm2 is a popular process manager for node.js applications.
To install pm2, run `npm install pm2 -g`.
To start the server with pm2, run `pm2 start server.js`.
To make the application run on server reboot, run `pm2 startup` and follow the instructions.
Read more about pm2 here: https://www.npmjs.com/package/pm2
This will start the server on port specified in .env || 8080 by default.