https://github.com/theladeli/home-extension-checklist

Streamline your home extension planning with BuildBuddy's dynamic checklist feature, designed to enhance project management efficiency.
https://github.com/theladeli/home-extension-checklist

Last synced: 6 days ago
JSON representation

Streamline your home extension planning with BuildBuddy's dynamic checklist feature, designed to enhance project management efficiency.

• Host: GitHub
• URL: https://github.com/theladeli/home-extension-checklist
• Owner: theLadEli
• Created: 2024-04-15T15:14:25.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-06-13T15:54:17.000Z (7 months ago)
• Last Synced: 2024-11-09T14:26:46.668Z (2 months ago)
• Language: HTML
• Size: 9.16 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# BuildBuddy Home Extension Checklist Tool

This tool is designed to assist users in the early stages of planning home extensions by providing a dynamic checklist based on user input. It aims to keep users engaged with the BuildBuddy app throughout the planning process, converting them from registrants to active users.

## Table of Contents

- [BuildBuddy Home Extension Checklist Tool](#buildbuddy-home-extension-checklist-tool)

  - [Table of Contents](#table-of-contents)

  - [Features](#features)

  - [Usage](#usage)

  - [Tech Stack](#tech-stack)

  - [Dependencies](#dependencies)

  - [Contributing](#contributing)

  - [License](#license)

  - [Contact](#contact)

## Features

- **Dynamic Checklist Generation**: Based on user's input during the onboarding flow, the tool dynamically generates a checklist tailored to the user's specific needs.

- **Gamified User Experience**: Includes progress bars and interactive tips to enhance user engagement and provide educational value.

- **Local Storage Utilization**: Saves user's inputs and checklist progress in the browser's local storage for persistence without backend complexity.

- **Responsive Design**: Ensures a seamless experience across various devices and screen sizes.

## Usage

To use the application, simply visit this URL to access the latest version of the web-app, hosted on GitHub Pages: [theladeli.github.io/home-extension-checklist](https://theladeli.github.io/home-extension-checklist/)

Start by entering the onboarding flow, answer the questions about your home extension project, and view the dynamically generated and interactive checklist tailored to your needs.

## Tech Stack

- **HTML**: Structure of the web pages.

- **CSS**: Styling and responsive design.

- **JavaScript**: Core functionality for dynamic checklist generation and local storage management.

- **jQuery**: Simplifies DOM manipulations and event handling.

## Dependencies

- **PapaParse**: Used for parsing CSV files that contain the checklist data. This library is included in the project.

## Contributing

Contributions are what make the open-source community such a powerful place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

To contribute:

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## License

[To be added]

## Contact

Feel free to contact us for any questions, feedback, or suggestions.