Skip to content

boone-studios/uptime

Repository files navigation

Uptime Dependencies

With its simple interface, Uptime provides a way to monitor website uptime for either in-house projects or clientele. Many services that provide the same functionality require you to pay out of pocket, and typically are not self-hosted. Though several robust open source applications like this exist already, Uptime is still to be a powerful open source alternative that one can host their own, on any desktop or laptop device.

Disclaimer

This application is still under development and has not officially released yet. Though it is mostly functional and free for contribution, we please ask you to keep in mind that it is not ready for production just yet.

Requirements

Uptime requires very little to get up and running. The first step is to ensure that you have the latest versions of Node and MongoDB installed. Visit the following links on how to install each for your system:

Uptime was developed on Node 4.5.0, so for best results we recommend installing this version or higher.

Installation

Installing Uptime is a breeze. After installing Node and Mongo, clone this repo down to your device from your command line:

git clone https://github.com/boone-software/uptime.git

After the repo is successfully cloned, cd into its directory and simply run the following to install all Node dependencies:

npm install

That's it! After all dependencies are completely installed, and you have configured MongoDB, you should be free to run Uptime on whatever port you like! You can do so with the following in two separate sessions:

mongod
npm start

Recommendations

When developing Node applications, we prefer to use a utility called nodemon, which monitors your development environment for changes and restarts your Node server.

If you plan to use Uptime in production, it may be best to use a utility like nodemon to prevent unmonitored app crashes. Because this is a personal recommendation, we have thoughtfully left it out of the dependencies.

Visit the website for more information.

Contributors

Interested in contributing? Since Uptime is still in its infancy there are a lot of places this application can go. It can become whatever our imaginations allow it. If you have an idea to extend this application, feel free to fork this repo and, if we find your contribution as much needed to Uptime, we will merge it in.