README.md

LIVE PREVIEW

Quickstart

1. Check if your computer has npm and NodeJS installed using node -v npm -v. Installation instructions can be found here
2. Install project packages using the npm install in the same directory as the package-lock.json file.
3. Duplicate .envexample, rename to .env and update all database values accordingly.
4. Run npm run three for frontend only or npm run server for full stack application.

Building static / to Github Pages

1. GITHUB PAGES ONLY: Set PRODUCTION variable to "true" inside the .env file
2. npm run build - builds static page
3. Copy over the house model folder /models to the /dist folder that was generated by npm run build.
4. GITHUB PAGES ONLY : Push the built folder to Github pages.git add dist -f, git commit -m "Adding dist", git subtree push --prefix dist origin gh-pages
5. Preview on local machine - only works if PRODUCTION is set to "false" - before npm run build command is ran.

Tech used

• ExpressJS - Backend
• PostgreSQL - Database
• Sequelize - Sits on top of Postgres. Using for model instances.
• ThreeJS - Render 3D objects
• Nodemon - Refresh on file save for ExpressJS
• dotenv - Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env.