Portfolio Party

A modern portfolio showcase platform built with React, TypeScript, and Vite.

Overview

Enter in a city (in the US), lookup the portfolios of people within that city, completely

Pages

Landing Page

[Content to be added as features are developed]

Authorization Page

Log in + Sign up feature

Leaderboard Page

[Content to be added as features are developed]

Personal Portfolio Page

[Content to be added as features are developed]

Other's Portfolio Page

[Content to be added as features are developed]

Development

Prerequisites

• Node.js (version 18 or higher)
• npm or yarn package manager

Getting Started

1. Clone the repository:

   git clone [repository-url]
   cd PortfolioParty

2. Start the backend:

   cd backend
   pip install -r requirements.txt
   python app.py

3. Navigate to the frontend directory:

   cd frontend

4. Install dependencies:

   npm install

5. Start the development server:

   npm run dev

6. Open your browser and navigate to http://localhost:5173/

Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm run preview - Preview production build
• npm run lint - Run ESLint

Project Structure

frontend/
├── src/
│   ├── components/     # Reusable UI components
│   ├── pages/         # Page components
│   ├── hooks/         # Custom React hooks
│   ├── lib/           # Utility functions
│   └── main.tsx       # Application entry point
├── public/            # Static assets
└── package.json       # Dependencies and scripts

Technology Stack

• Frontend Framework: React 18 with TypeScript
• Build Tool: Vite
• Styling: Tailwind CSS
• UI Components: shadcn/ui
• Routing: React Router DOM
• State Management: TanStack React Query
• Package Manager: npm

Development Guidelines

• Test all changes thoroughly on localhost before pushing to main
• Update this README when adding new features or pages
• Follow TypeScript best practices
• Use shadcn/ui components for consistent UI
• Maintain responsive design principles

Contributing

Please ensure all changes are tested locally before making changes straight to main. Update the README as you go along creating new features/pages

Can't wait to start working with you all!