Shared Washers

A simple solution to shared washing machines & dryer in a building
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Libraries Used
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About The Project

I currently live on the third floor of a three-story building with eleven other apartments/people. One of the drawbacks of living on the top floor is having to walk down four flights of stairs for a load, only to discover that the washing machines are in use, and then having to go back and repeat the process several times.

(back to top)

Built With

• 
• 

(back to top)

Libraries Used

• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. 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.

• Node.js and npm

  https://docs.npmjs.com/downloading-and-installing-node-js-and-npm

Installation

1. Clone the repo

   git clone https://github.com/alexandrosmagos/shared-washers.git

2. Install NPM packages

   npm install

(back to top)

Usage

The app's goal was to be simple. On the initial load of the website, you will see the status of the machines in real time. Starting or Stopping a machine will also update other people's screens in real time.

(back to top)

Roadmap

• Two washing machines and one Dryer
• Start / Stop Functionality
• Time passed timer in format MM:SS while <60 minutes, else HH:MM
  • If time passed > 24h, format something like 2D 5H
• Implement 4 number pin code with sessions

See the open issues for a full list of proposed features (and known issues).

(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 with the tag "enhancement". 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 GPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

• Project Icon from flaticon
• Washing machines are designed by Arkellys on Codepen

(back to top)