FreshTrak Client

A React-based web application for managing food bank events and registrations.

Quick Start

Prerequisites

Make sure you have yarn or npm installed.

Installation

# Install dependencies
yarn install
# or
npm install

Development

# Start development server
yarn start
# or
npm start

Open http://localhost:3000 to view it in the browser.

Testing

# Run tests
yarn test
# or
npm test

Building for Production

# Build the app
yarn build
# or
npm run build

Documentation

This project's documentation is organized in the docs/ directory:

📁 General Documentation

• Project Overview - Complete project setup and development guide

📁 Frontend Documentation

• Setup Guide - Frontend development setup and configuration
• Features - Detailed feature documentation
  • Map Feature - Interactive maps implementation

📁 Deployment Documentation

• AWS deployment configuration and procedures

Key Features

• Interactive Maps: Location-based services with Google Maps integration
• Event Management: Comprehensive event creation and management
• User Registration: Streamlined user registration process
• Responsive Design: Mobile-first responsive interface
• Real-time Updates: Live data synchronization

Technology Stack

• Frontend: React, Redux, React Router
• Styling: SCSS, Bootstrap (migrating to Tailwind CSS)
• Maps: Google Maps API, Leaflet
• Testing: Jest, React Testing Library
• Build: Create React App, Webpack

Contributing

Please refer to the documentation in the docs/ directory for detailed development guidelines and feature specifications.

License

This project is part of the FreshTrak platform for food bank management.