FreebieFlow

React TypeScript Tailwind CSS

A simple, modern Progressive Web App (PWA) to track your recurring free service credits. Never miss a renewal date or lose track of your monthly allowances again.

Preview

(It’s highly recommended to replace this with a screenshot or GIF of the running application!)

FreebieFlow App Screenshot

✨ Features

🚀 Tech Stack

🛠️ Getting Started

This project is set up to run directly in the browser without any build steps or package installations.

Prerequisites

You only need a modern web browser and a way to serve the files from a local web server.

Running the App

Because this app uses ES modules (import), you need to serve the files from a local web server rather than opening the index.html file directly from your file system. Here are two easy ways to do it:

Option 1: Using the VS Code Live Server Extension

  1. If you use Visual Studio Code, install the Live Server extension.
  2. Clone the repository:
    git clone https://github.com/YOUR_USERNAME/freebieflow.git
    
  3. Open the cloned folder in VS Code.
  4. Right-click on the index.html file and select “Open with Live Server”.

Option 2: Using Python’s built-in server

  1. Make sure you have Python 3 installed.
  2. Clone the repository:
    git clone https://github.com/YOUR_USERNAME/freebieflow.git
    
  3. Navigate into the project directory:
    cd freebieflow
    
  4. Start the server:
    python -m http.server
    
  5. Open your web browser and go to http://localhost:8000.

📂 Project Structure

/
├── components/         # Reusable React components
│   ├── AddServiceModal.tsx
│   ├── ServiceItem.tsx
│   ├── ServiceList.tsx
│   └── icons.tsx
├── services/           # Handles external interactions (e.g., localStorage)
│   └── storageService.ts
├── utils/              # Helper functions and business logic
│   └── renewalUtils.ts
├── App.tsx             # Main application component
├── index.html          # HTML entry point
├── index.tsx           # React root renderer
├── metadata.json       # Application metadata
├── types.ts            # TypeScript type definitions
└── README.md           # This file

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page. A major area for future improvement would be adding an optional cloud sync feature using a service like Firebase.

📧 Support

For questions, bug reports, or feature requests, please contact:

📄 License

This project is open source and available under the MIT License.