mahtaran / maht-home

Maht's Home Management system

Maht's Home

A home management system for
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Why Maht's Home?
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Maht's Home is a simple home management system that makes a home more efficient and easier to manage. It is a web application that can be accessed from any device with a web browser.

(back to top)

Why Maht's Home?

While a few systems were already available as far as I know of, I chose to create my own system. Why?

• Few of the existing systems were easy to install.
• None of the existing systems had all the features I wanted.

So why should you use Maht's Home? Below is a list of all planned features.

• It is easy to install, use & customise.
• It is as free and open source as it can be.
• It has many useful and powerful features, such as:
  • An inventory that can be used to track items in your home.
    • Items can have a location, quantity, and expiration date.
    • Items can be grouped into categories.
    • Items can be added to and from a shopping list.
    • Items can be added to and from a meal.
    • An overview page of soon-expiring items is available.
    • An overview page of items that are low in quantity is available.
    • Users can be notified when items are low in quantity or soon-expiring.
  • A calendar that can be used to schedule events, tasks, and reminders.
  • A shopping list that can be used to keep track of items to buy.
  • A to-do list that can be used to keep track of tasks to do.
  • A notes section that can be used to keep track of notes.
  • A dashboard that can be used to keep track of important information.
  • A settings section that can be used to configure the system.
  • A user management section that can be used to manage users.

(back to top)

Built With

(back to top)

Getting Started

This guide is not yet finalised and may not be complete. It is also not yet tested.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js 14

  # To check if Node.js is installed, run the following command:
  node --version
  # It should return a version number, such as v14.20.1. Ensure it starts with v14.

  • It is recommended you use a Node.js version manager such as nvm (for Linux and macOS) or nvm-windows (for Windows).
• Meteor

  # To check if Meteor is installed, run the following command:
  meteor --version
  # It should return a version number, such as Meteor 2.7.3. Ensure it starts with Meteor 2.

Installation

1. Clone the repo

   git clone https://github.com/Mahtaran/maht-home.git

2. Run the app
   • UNIX

   cd maht-home
   scripts/run.sh

   • Windows

   cd maht-home
   scripts\run.ps1

(back to top)

Usage

Soon, this space will show useful examples of how a project can be used. Additional screenshots, code examples and demos might be added, as well as links to more resources.

For more examples, please refer to the Documentation (to be done)

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the Unlicense. See license.md for more information.

(back to top)

Contact

Main contact: Luka "Mahtaran" Leer

(back to top)

Acknowledgments

• Readme template by Othneil Drew

(back to top)