Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sukarnascience/mysmarthome
https://github.com/sukarnascience/mysmarthome
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sukarnascience/mysmarthome
- Owner: Sukarnascience
- License: mit
- Created: 2023-12-16T11:59:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-30T07:47:53.000Z (about 1 year ago)
- Last Synced: 2023-12-30T08:28:41.716Z (about 1 year ago)
- Language: HTML
- Size: 252 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Home Server Web Application
Home Server Web Application is a versatile project designed to simplify the connection to your home server. Easily redirect to your server's IP and port using this web application, providing a seamless experience for home automation enthusiasts.
## Features
- **Connect to Server:** Enter the IP address or URL of your home server to seamlessly connect.
- **Dynamic URL Handling:** Open the provided URL directly, with robust handling for various status codes.
- **Offline Support:** Utilizes a service worker to cache pages for uninterrupted access, even in offline mode.
- **Timeout Handling:** If the server connection takes more than 30 seconds, it gracefully redirects to `unreachable.html`.
## Getting Started
Follow these steps to get the project up and running on your Raspberry Pi or any PC:
### Prerequisites
Ensure that you have the following installed:
- [Specify any prerequisites or dependencies]
### Installing
1. Clone the repository:
```bash
git clone [URL]
```
2. Navigate to the project directory:
```bash
cd home-server-web-app
```
3. Open `index.html` in a web browser.
## Usage
1. Run your server on the Raspberry Pi or any PC. You can find the Home Server repository and instructions [here](https://github.com/Sukarnascience/Pingu_Bot).
2. Clone the Home Server Web Application repository:
```bash
git clone https://github.com/Sukarnascience/Pingu_Bot
```
3. Navigate to the project directory:
```bash
cd Pingu_Bot/src
```
1. Click the connect button to access various functionalities such as Movie Room, Dump Yard, Home Appliance Control, and more.
### Movie Room
The Movie Room feature allows users to transform their home server into an Over-The-Top (OTT) platform-like experience. Users can:
- Stream and watch movies.
- Organize and categorize their movie library.
- Enjoy a user-friendly interface for selecting and playing movies.
This feature provides a personalized and convenient way to manage and enjoy a collection of movies.
### Dump Yard
The Dump Yard feature serves as a centralized storage and file management system. Users can:
- Upload files from any PC to their home server.
- Organize and categorize files based on preferences.
- Retrieve and access files seamlessly.
It acts as a secure and accessible repository for storing various types of files, enhancing data management and accessibility.
### Home Appliance Control
Home Appliance Control feature empowers users to manage and control various devices within their home. Users can:
- Control home appliances remotely.
- Schedule and automate appliance tasks.
- Monitor the status and energy usage of appliances.
This feature contributes to home automation, offering a smart and efficient way to manage domestic devices for increased comfort and energy efficiency.
These functionalities collectively create a comprehensive home server environment that combines entertainment, file management, and home automation capabilities, enhancing the overall user experience.
## Built With
- HTML, CSS, JavaScript
- [List any additional technologies or libraries used]
## Contributing
We welcome contributions! Follow these steps to contribute:
1. Fork the project.
2. Create a new branch: `git checkout -b feature/YourFeature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin feature/YourFeature`
5. Submit a pull request.
## Authors
- Sukarna Jana
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Acknowledgments
- Mention anyone or any resources that inspired or helped you during the development.