brookelkennison / Home-Fix-Social

Instant Messaging for DIY Home Renovations and Fixes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Home Fix Social

Instant messaging for the not-so-handy DIY home renovators and project tacklers!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Product Name Screen Shot

Ever taken on a task of tackling a home project that you knew nothing about and knew no one that could answer all of your many questions? This app is for you. This instant messaging platform can provide you with the answers to your questions in a matter of seconds from other DIY home project tacklers. I'm determined to figure this out together!

My inspiration:

  • In early 2021 I purchased a 1952 ranch style home. This home needed a lot of work, and I was determined to renovate it with my own two hands.
  • Youtube was the source of the answers to my questions, but when they didn't answer my questions I had no one to ask for advice when I needed the answer within a few minutes.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/brookelkennison/Home-Fix-Social.git
  2. Install NPM packages
    npm install
  3. Run the app in the development mode
    yarn start
    

Other Scripts:

Launches the test runner in the interactive watch mode.

yarn test

See the section about running tests for more information.

Builds the app for production to the build folder.

yarn build

See the section about deployment for more information.

Eject the build. Note: this is a one-way operation. Once you eject, you can’t go back! This command will remove the single build dependency from your project.

yarn eject

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the [open issues] (https://github.com/brookelkennison/Home-Fix-Social/issues) for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  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

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/your_username/repo_name

Acknowledgements


You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

About

Instant Messaging for DIY Home Renovations and Fixes


Languages

Language:TypeScript 42.9%Language:HTML 37.0%Language:CSS 20.0%