Skip to content

README.md

Latest commit

 

History

History
109 lines (85 loc) · 2.7 KB

README.md

File metadata and controls

109 lines (85 loc) · 2.7 KB

RFP Tracker Pro

Track RFPs from SAM.gov, state sites, and custom sources with push alerts and calendar sync.

Features

  • 📊 Dashboard Overview - View all RFPs with status tracking and statistics
  • 🔍 Advanced Filtering - Filter by status, source, value range, and search terms
  • 🏛️ Multiple Sources - SAM.gov, state sites, and custom source management
  • 🔔 Push Alerts - Toggle alerts for individual RFPs
  • 📅 Calendar Integration - Sync RFP deadlines with your calendar
  • 🎨 Modern UI - Built with React, TypeScript, and Tailwind CSS

Installation

Prerequisites

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

Git Installation

  1. Clone the repository:

    git clone <repository-url>
cd rfp-tracker-pro

  2. Install dependencies:

    npm install
# or
yarn install

  3. Start the development server:

    npm run dev
# or
yarn dev

  4. Open your browser: Navigate to http://localhost:5173 to view the application.

Alternative Installation Methods

Using npm create

npm create vite@latest rfp-tracker-pro -- --template react-ts
cd rfp-tracker-pro
npm install
npm run dev

Using yarn create

yarn create vite rfp-tracker-pro --template react-ts
cd rfp-tracker-pro
yarn install
yarn dev

Available Scripts

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

Technology Stack

  • Frontend: React 18 + TypeScript
  • Build Tool: Vite
  • Styling: Tailwind CSS
  • UI Components: Radix UI + shadcn/ui
  • Icons: Lucide React
  • State Management: React Context
  • Routing: React Router DOM

Project Structure

src/
├── components/          # Reusable UI components
│   ├── ui/             # shadcn/ui components
│   ├── Dashboard.tsx   # Main dashboard view
│   ├── FilterPanel.tsx # Advanced filtering
│   ├── RFPCard.tsx     # Individual RFP display
│   └── SourceManager.tsx # Custom source management
├── contexts/           # React contexts
├── hooks/              # Custom React hooks
├── lib/                # Utility functions
└── pages/              # Page components

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License.