https://github.com/masaishi/web_cruzhacks2024
https://github.com/masaishi/web_cruzhacks2024
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/masaishi/web_cruzhacks2024
- Owner: masaishi
- Created: 2024-01-19T04:21:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-21T15:46:58.000Z (over 1 year ago)
- Last Synced: 2025-01-17T20:41:00.534Z (5 months ago)
- Language: JavaScript
- Homepage: https://web-cruz-hacks2024.vercel.app
- Size: 1.02 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# web_Sitegeist
## Overview
web_Sitegeist is a Nextjs application. This application provides a user-friendly interface to visualize and interact with data collected from Reddit. It features components like a search bar, data visualization charts, and integration with ChatGPT for dynamic interaction.
**[Live Demo](https://web-cruz-hacks2024.vercel.app/)**
**[Initial Design / Figma](https://www.figma.com/file/13P6GwI9DUAjRbJgJ40lPy/CruzHacks2024?type=design&node-id=0%3A1&mode=design&t=PWgJAPwbHJR6uUWK-1)**## Features
- **Data Visualization**: Implements a Pie Chart to represent data distribution visually.
- **ChatGPT Integration**: Includes an AskGPT component for generating conversational responses based on user interactions.## Getting Started
### Prerequisites
- Node.js and npm
- React and Material-UI
- An IDE or text editor for JavaScript development### Installation
1. Clone the web_Sitegeist repository:
```bash
git clone https://github.com/masaishi/web_CruzHacks2024
```2. Navigate to the project directory and install dependencies:
```bash
cd web_CruzHacks2024
npm install
```### Running the Application
1. Start the React development server:
```bash
npm start
```2. Open a web browser and navigate to `http://localhost:3000`.
### Deployment
It use Vercel for deployment. Thus, if we push to the main branch, it will automatically deploy to the live demo.