PDX Deploy Application
Table of contents
About
PDX Deploy is an intuitive data visualization application that manages and monitors critical assets, issues detailed reports, maps degradation trends and predicts potential failures to achieve worry-free uptime.
More Details
Check out the /docs/ folder for lots of details on things like tech choices (with links), project ideas, current goals, and current bugs.
Getting Started
Project setup
Follow the instructions for everything in this section to have a fully prepared dev system.
| Task | Instructions |
|---|---|
| Database daemon | Make sure MongoDB is running. This project assumes you've set it up as a native daemon to your OS or otherwise have it running on port 8099. If you know what is your MongoDB connection URL, you should be smart enough to change this connection string URL in the .env. |
| Environment variables | Fill out the .env file. The .env is a valid set of values to use, but you may wish to customize. |
| Installing Node packages | Run npm install to install packages. |
| Dev servers | Run npm run dev in working directory to get going with hot reloading and run "nodemon app.js -- -d "data/folder/path"'. Visit http://localhost:3000 for dev server. |
| Creating production builds | Run npm run build to have production builds that you can test locally To test the server serving the production build, you can simply run npm run start in working directory and navigate to http://localhost to get the homepage. You may edit .env vars, as the production build will use the values in the .env file, which are solely geared towards actual deployment. The production build locally is often useful to look at merely to see that styling is consistent, as there have been bugs in the past with this (fully solved at this point). |
| Running tests | Run npm run test to run tests once. |
Deployment
| Types | Instructions |
|---|---|
| Docker Container | Deploy with Dockerfile: run "npm run dockerBuild" to build docker image |
| Windows Executable | Deploy with Windows: run "npm run build" to build windows executable |
| Linux Executable | Deploy with Linux: run "npm run build" to build linux executable |
| Mac Executable | Deploy with Mac::run "npm run build" to build Mac executable |
| Docker Compose | Just install docker-compose on the linux system using this link, add docker-compose.yml file and run "docker-compose up ." it will take care of every thing |
Running Production Executables
| Types | Instructions |
|---|---|
| Docker Container | run 'docker run --env NODE_TLS_REJECT_UNAUTHORIZED=0 --net=host -d --name pdx -v "/server/folder/name:/home/matlab" pdxdocker/base_v3' |
| Windows Executable | run "executable -d 'data/folder'" for online or run "executable -d 'data/folder' -m "offline" for offline mode" |
| Linux Executable | run "executable -d 'data/folder'" for online or run "executable -d 'data/folder' -m "offline" for offline mode" |
| Mac Executable | run "executable -d 'data/folder'" for online or run "executable -d 'data/folder' -m "offline" for offline mode" |
| Docker Compose | add docker-compose.yml file and run "docker-compose up ." |
Creating Installation Wizard for Windows Server
For creating Installation wizard we are using Inno Setup software. It needs configuration file and dependency dlls to make it work all are going to be present inside of repository.