Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 3.44 KB

README.md

File metadata and controls

68 lines (46 loc) · 3.44 KB

⚡ Company Analytics

  • PostgreSQL Express React Node (PERN) full-stack app, integrates React frontend with Node.js backend that is deployed to Heroku. *** Note: to open web links in a new window use: ctrl+click on link / cmd+click on link**

📚 General info

Backend

  • PostgreSQL needs to be installed and running - I started it from my Windows 10 PostgreSQL 13 dropdown option 'SQL shell (psql)'
  • Postman used to test the backend before frontend was available

Frontend

  • React frontend includes a display of analytics for a given company
  • JavaScript XML (JSX) used to write HTML elements in Javascript
  • React Fragments used to show table of analytics as a row with columns in the DDM

📶 Technologies - Backend

📶 Technologies - Frontend

💾 Dev Setup - Backend

  • Install dependencies using npm i
  • Install nodemon globally if you don't already have it
  • Install PostgreSQL & run it (requires the password you created during installation)
  • Add database access credentials to db.js - recommend installing npm dotenv & using .env to hide credentials if commiting to Github
  • Postgresql shell commands: \l list all databases. \c database1 connect to database1. \dt inspect tables. \d+ inspect table & show relation information. \q to quit
  • From root run nodemon server for a dev server
  • http://localhost:5000/ can be accessed for CRUD operations such as POST, GET, PUT, DELETE etc. using Postman

💾 Dev Setup - Frontend

  • Change to client directory
  • Install dependencies using npm i.
  • run npm start. Frontend will open at http://localhost:3000/

💾 Push to GitHub

  • Questions should contact Jess on how to pull and push

🆒 Features - Backend

  • All data stored in PostgreSQL database that can also be viewed and changed from the PostgreSQL shell (psql)

🆒 Features - Frontend

👏 Inspiration/General Tools