Skip to content

Powahm/uxhack26

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UXHack 2026

A full-stack web application built with React + Vite + Tailwind CSS (frontend) and Flask (backend).


Project Structure

uxhack26/
├── backend/
│   ├── app.py            # Flask application
│   └── requirements.txt  # Python dependencies
├── frontend/
│   ├── src/
│   │   ├── components/   # Shared & shadcn UI components
│   │   ├── pages/        # Page-level components (SignupPage)
│   │   ├── lib/          # Utility helpers
│   │   ├── App.tsx
│   │   ├── main.tsx
│   │   └── index.css     # Tailwind + CSS variables
│   ├── index.html
│   ├── package.json
│   ├── tailwind.config.js
│   └── vite.config.ts
├── run.bat               # Start both servers (Windows CMD)
├── run.ps1               # Start both servers (PowerShell)
└── README.md

Prerequisites

Tool Minimum version
Node.js 18+
npm 9+
Python 3.10+

Getting Started (first-time setup for collaborators)

Follow these steps once after cloning the repo.

1. Clone the repository

git clone https://github.com/Powahm/uxhack26.git
cd uxhack26

2. Install Node.js (if you haven't already)

Download and install from https://nodejs.org (LTS version, 18+).
Verify with:

node -v
npm -v

3. Install the requirements for OpenCV

pip install -r requirements.txt

3. Install Python (if you haven't already)

Download and install from https://python.org (3.10+).
Verify with:

python --version

4. Run the project

Simply double-click run.bat, or in a terminal:

run.bat

The script will automatically:

  • Create a Python virtual environment in backend/.venv/
  • Install all Python packages from backend/requirements.txt
  • Install all Node packages from frontend/package.json
  • Start both servers

Open http://localhost:5173 in your browser.

You never need to commit node_modules/ or .venv/ — they are in .gitignore.
After pulling new changes just re-run run.bat and it will pick up any new dependencies automatically.


Quick Start

Option A — Run both servers at once (recommended)

CMD / Batch:

run.bat

PowerShell:

.\run.ps1

Both scripts will:

  1. Create a Python virtual environment inside backend/ (first run only).
  2. Install Python dependencies from backend/requirements.txt.
  3. Start the Flask server on http://localhost:5000.
  4. Install Node dependencies inside frontend/ (first run only).
  5. Start the Vite dev server on http://localhost:5173.

Option B — Manual setup

Backend

cd backend

# Create & activate virtual environment
python -m venv .venv
.venv\Scripts\activate        # Windows CMD / PowerShell

# Install dependencies
pip install -r requirements.txt

# Start Flask
python app.py

Flask will be available at http://localhost:5000.

Frontend

Open a second terminal:

cd frontend

# Install npm packages
npm install

# Start Vite dev server
npm run dev

Vite will be available at http://localhost:5173.


API Endpoints

Method Path Description
GET /api/health Health check
POST /api/signup Register a new user

POST /api/signup — Request body

{
  "name": "John Doe",
  "email": "[email protected]",
  "password": "securepassword"
}

Features

  • Signup page – full client-side validation (name, email, password strength, password match).
  • Light / Dark mode – toggle button in the top-right corner, persisted via next-themes.
  • shadcn/ui componentsButton, Input, Label, Card.
  • Proxy – Vite proxies /api/* requests to Flask, so no CORS issues in development.

Contributors

Roshan
Prasanna Balamurugan
Ridwaan
Aaditya Siripal

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors