Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/usd-cs/comp-491-24-25-sustainability-dashboard-intro-project

Last synced: 25 days ago
JSON representation

Host: GitHub
URL: https://github.com/usd-cs/comp-491-24-25-sustainability-dashboard-intro-project
Owner: usd-cs
Created: 2024-10-31T22:50:14.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-11-20T00:17:23.000Z (about 2 months ago)
Last Synced: 2024-11-20T01:20:51.947Z (about 2 months ago)
Language: JavaScript
Size: 37.2 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Sustainability Dashboard

## **Project Overview**

A Vue.js-based web application that integrates a backend built with Node.js and Express to provide a user authentication system. The project includes login functionality, dynamic routing, and a frontend designed for seamless user interactions. The backend connects to a PostgreSQL database to manage user data and authentication, ensuring secure and efficient access. Designed to support a sustainability-focused dashboard for energy data visualization and reporting.

---

## **Software Requirements**

### **Backend Requirements**

- [Node.js](https://nodejs.org/) (v16 or higher recommended)

- [Express.js](https://expressjs.com/) (v4 or higher)

- [PostgreSQL](https://www.postgresql.org/) (v12 or higher)

- [PM2](https://pm2.keymetrics.io/) (optional, for process management)

### **Frontend Requirements**

- [Vue.js](https://vuejs.org/) (v3 or higher)

- [Vite](https://vitejs.dev/) (v4 or higher)

### **Package Manager**

- [npm](https://www.npmjs.com/) (bundled with Node.js) or [yarn](https://yarnpkg.com/) (optional)

### **Development Tools**

- A modern code editor like [Visual Studio Code](https://code.visualstudio.com/)

- [Postman](https://www.postman.com/) (optional, for API testing) 

---

## **Environment Configuration**

Ensure you have the following environment variables configured:

1. **PostgreSQL Database Connection:**

   - `DB_USER` - PostgreSQL username

   - `DB_PASSWORD` - PostgreSQL password

   - `DB_HOST` - PostgreSQL host

   - `DB_PORT` - PostgreSQL port (default: 5432)

   - `DB_NAME` - PostgreSQL database name

2. **Backend API URL:**

   - `API_URL` - The base URL for the backend API (default: `http://localhost:3000`)

---

## **How to Run**

1. Clone the repository.

2. Install dependencies for both frontend and backend:

   ```bash

   # Navigate to the backend folder

   cd backend

   npm install

   # Navigate to the frontend folder

   cd ../frontend

   npm install